Skip to content
This repository has been archived by the owner on Aug 9, 2019. It is now read-only.

A boilerplate for docsify projects. ๐Ÿ“๏ธ

License

Notifications You must be signed in to change notification settings

FrancesCoronel/docsify-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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

About

A boilerplate for docsify projects. ๐Ÿ“๏ธ

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published