Skip to content

Pong420/docsify-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docsify Starter

This documents are produce by docsify.


To enable live reload run

yarn dev
# with custom port
yarn dev --port 5000

Plugins

List of plugins that used

  • docsify-darklight-theme - The main styles of this document. With some customized style handled in docs/js/darklightTheme.js and docs/assets/style.css

  • Prism - Used by docsify for code block. There are some extra prism components/plugins added

    • prism-bash
    • prism-json
    • prism-typescript
    • prism-line-highlight
  • docsify-pagination - Add page navigation components at footer

  • mermaid-docsify - Enable mermaid in docsify. It is a diagramming and charting tool that uses Markdown-inspired text definitions.

  • docs/js/scrollbar.js - Change scrollbar style of MS Window browser

  • docs/js/markdown.js - Add file and line highlight in code block

Code Block

Code block with file name
line highlight by metadata - 1
line highlight by metadata - 2
line highlight by metadata - 3

line highlight by comment - 1 <!-- highlight-line  -->

line highlight by comment - 2 <!-- highlight-line  -->