https://github.com/projectsyn/documentation

The Project Syn main documentation repository
https://github.com/projectsyn/documentation

asciidoc documentation projectsyn

Last synced: 7 months ago
JSON representation

The Project Syn main documentation repository

• Host: GitHub
• URL: https://github.com/projectsyn/documentation
• Owner: projectsyn
• License: bsd-3-clause
• Created: 2019-12-19T08:01:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-31T10:58:12.000Z (11 months ago)
• Last Synced: 2025-01-31T11:25:00.284Z (11 months ago)
• Topics: asciidoc, documentation, projectsyn
• Language: HTML
• Homepage: https://docs.syn.tools/
• Size: 3.14 MB
• Stars: 6
• Watchers: 13
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Project Syn Documentation

This is the umbrella documentation for Project Syn.

It is written using [AsciiDoc][asciidoc] and [Antora][antora]. The source is located in the [docs/](docs) folder.

The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.

Run the `make preview` 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 check` command and correct any warnings raised by the tool.

## Contributing and license

This library is licensed under [BSD-3-Clause](LICENSE).

For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).

[asciidoc]: https://asciidoctor.org/

[antora]: https://antora.org/