Starter template for a Markdown-based docs site 📒 🕸
MIT License
Starter template for a Markdown-based docs site
Instead of forking, rather make a new repo using this template button:
If you want to improve the original template, then fork it and make a PR.
How to use this project
docs
directoryFor more info on Docsify, see my DocsifyJS Tutorial. That covers intro to DocsifyJS, including installation, running and configuration. If you look at the repo, that has has more content and configuration than this relatively plain template site.
Use one of the approaches below to setup Docsify in your own project.
Create a new forked project based on this template by clicking the button below. You'll get a fork in your own repo.
You could start adding code outside of the docs directory, however this project is intended as a standalone docs site which can be configured for experimentation and used as reference.
This will copy the contents of the docs directory from Github to the current folder - ideal if there is an existing project and you want to add to Docsify it.
curl
command installed. Or use wget
.docs
folder.
cd my-project/docs
-O
flag will save the files locally, keeping the original filenames.)
REPO_DOCS='https://raw.githubusercontent.com/MichaelCurrin/docsify-js-template/master/docs/'
curl $REPO_DOCS\{_coverpage.md,_sidebar.md,.nojekyll,index.html,README.md\} -O
You can use your IDE to do find and replace across files.
Use the convenient replace.sh script in this repo to replace the template's values with your own.
curl 'https://raw.githubusercontent.com/MichaelCurrin/docsify-js-template/master/replace.sh' -O
chmod +x ./replace.sh
MY_
values then run this script to replace the template's value with your own../replace.sh
Now complete any remaining TODO items in the files.
If you clicked Use this template, followed the customize steps above, then the last thing to do is replace the project's README.md file with the template one.
mv README.template.md README.md
Then customize README.md as your own project.
Whatever approach you use to set up a docs
directory, you can use your own project or a forked template and serve your site on platform like GiHhub Pages or Netlify.
This template still works fine as a standalone online demo of Docsify that you can tweak. In a real project, you'd add your code at the repo root, outside of docs
. Or you could move your docs site to the repo root on the gh-pages
branch for GH Pages.
Follow this gist so you can view the docs site on a local webserver.
Go to my DocsifyJS Tutorial - Serve locally for more info on what DocsifyJS is and how to use it.
A template using Docsify Themeable. It is a Docsify site but easier to use, it is prettier (in my opinion), and supports a theme system that is more advanced than that in Docsify.
A template for Vue-based docs site. Except it uses VuePress to render a static site (better for SEO) rather than as a Single-Page Application like Docsify.
A template for a Vue-based app.
Released under MIT by @MichaelCurrin.
LICENSE
to LICENSE-source
and then update your copy of LICENSE
with your own details.