Skip to content
A boilerplate for docsify projects. πŸ“οΈ
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
favicon.ico
manifest.json
sw.js

README.md

Docsify Starter

docsify-starter

GitHub Issues GitHub Pull Requests MIT License Become a Patron!

A boilerplate for docsify projects. πŸ“οΈ

View this project at https://docsify.fvcproductions.com

Installation

It is recommended to globally install docsify-cli globally, which helps initializing and previewing the website locally.

npm i -g docsify-cli

Usage

Run the local server with docsify serve.

You can preview your site in your browser on http://localhost:3000.

docsify serve docs

Contributing

To get started...

  1. 🍴 Fork this repo
  2. πŸ”¨ View the contributing guidelines at CONTRIBUTING.md
  3. πŸ‘₯ Add yourself as a contributor under the credits section
  4. πŸ”§ Open a new pull request
  5. πŸŽ‰ Get your pull request approved - success!

Or just create an issue - any little bit of help counts! 😊

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

More details can be found at this project's CODE_OF_CONDUCT.md.

Credits

You can’t perform that action at this time.