Set up you markdown files site in one minute, powered by Docsify.
Your ⭐ would be high praise for my efforts, thank you!
Demo is here: Maxlinn's Docsify Template Demo.
对于中文用户,您可以使用
zh-CN
分支。
- Click the
Use Template
button to initialize your project.fork
is also appropriate. The advantage is that you can easily merge my upcoming updates by clickfetch-upstream
button, the disadvantage is that you can not set a forked public repository to private.- You'll get a
main
branch with those files - To modify:
index.html
, settings, must modify, at least modify those commented with!!!
.README.md
, homepage of your site, change it to yours._navbar.md, _sidebar.md, _footer.md
, change it to yours. Remove any if you don't like.favicon.svg
, the icon your site, change it to yours. To use other format, editindex.html
.
- To remove:
- Folder
a-great-subfoloder
, just for demo, remove it and its contents.
- Folder
- Nevermind:
.nojekyll
, nevermind.
- Go to repository settings, set
github pages
work onmain
branch. - Done!
README.md
of each folder level would serve as homepage of this level, like this one you are reading.- So don't hesitate to change this
README.md
to create your own homepage!
- So don't hesitate to change this
- The sidebar serve as a document navigator as well as
table of contents
of current document.- The sidebar item starts with an
-
belongs totable of contents
of current document. - Other sidebar items are defined in
_sidebar.md
.
- The sidebar item starts with an
- To disable features, comment its plugin
<script>
tag insideindex.html
.
Powered by plugins of docsify, and community contributions.
- Full text search.
- Discover documents by hyperlinks of the documents you viewed, like a web spider.
- Implemented just in frontend.
- Not always index all documents of this site.
- Search index rebuilt every one day by default, stored in localstorage.
- Dark mode switch button.
==
highlight syntax support.- LaTeX, mermaid.js, code highlight support.
- Custom font settings.
- User experience enhancement.
- Copy code button.
- PanGu, add space when Chinese and English characters drawing near.
- Collapsable nested sidebar.
- Support tabs syntax, see examples in syntax test below.
deleted
==hightlight==
⭐
sequenceDiagram
Alice->John: Hello John, how are you?
loop every minute
John-->Alice: Great!
end
for i in range(42):
print("calm down")
- Bold of headings(
**
) is necessary to trigger the syntax! - Though it uses headings, it won't affect headings of markdown.
- If two of more tabs contain tab of the same name, once a tab is selected, all tabs of the same name will be selected.
- It is extremely useful to show codes of different languages.
<!-- tabs:start -->
### **English**
Hello!
### **French**
Bonjour!
### **Italian**
Ciao!
<!-- tabs:end -->
Hello!
Bonjour!
Ciao!
<!-- tabs:start -->
<!-- tab:English -->
Hello!
<!-- tab:French -->
Bonjour!
<!-- tab:Italian -->
Ciao!
<!-- tabs:end -->
Hello!
Bonjour!
Ciao!