Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dickeyy/docs

Documentation for a variety of my OSS projects
https://github.com/dickeyy/docs

Last synced: 5 days ago
JSON representation

Documentation for a variety of my OSS projects

Awesome Lists containing this project

README

        

# Kyle Docs

This repository contains the documentation for a variety of my projects.

I use [GitBook](https://www.gitbook.com) to host the 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. 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](LICENSE) file for details.