Skip to content

Winds-Studio/Leaf-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Leaf Docs

CC BY-NC-SA 4.0 MIT

The repository of official Leaf docs site, powered by Material for MkDocs documentation framework.

Visit the docs site in https://docs.leafmc.one/

📦 Development

Prerequisite

Python 3.8.2+

Installtion

Refer to Getting started for more.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

    mkdocs.yml      # The configuration file.
    docs/           # documentations with different languages
        en/
        zh/
    ...

⚖️ License

Leaf docs's documentations (e.g. .md files under /docs folder) are licensed under CC BY-NC-SA 4.0. The supporting code is licensed under MIT.

📜 Credits

About

Documentation for Leaf project

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE-docs

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •