Skip to content

velojs/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Velo Docs

We use GitBook to generate our documentation. The documentation is written in Markdown and is located in the docs folder.

Modifying the Documentation

To create or modify any of the documentation, you simply need to edit the Markdown files in the docs folder. We use the GitBook Editor internally, but you can use any Markdown editor you like.

To create a new page:

  1. Create a new Markdown file in the docs folder.
  2. Add the new page to the SUMMARY.md file.

To modify an existing page:

  1. Edit the Markdown file in the docs folder. duh

Contributing

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Push your changes to your fork.
  5. Create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.