Skip to content

mweibel/documentation

 
 

Project Syn Documentation

This is the umbrella documentation for project syn. It is written using Asciidoc and Antora and located in the docs/ folder. The Divio documentation structure is used to organize its content.

Run the make docs-serve command in the root of the project, and then browse to http://localhost:2020 to see a preview of the documentation.

After writing the documentation, please use the make docs-vale command and correct any warnings raised by the tool.

Contributing and license

This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.

About

The Project Syn main documentation repository

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 61.6%
  • Shell 25.9%
  • Dockerfile 7.3%
  • Makefile 5.1%
  • Ruby 0.1%