https://github.com/projectsyn/component-storage-local-static
https://github.com/projectsyn/component-storage-local-static
commodore commodore-component projectsyn storage syn
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/projectsyn/component-storage-local-static
- Owner: projectsyn
- License: bsd-3-clause
- Created: 2023-05-15T13:21:17.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T08:41:58.000Z (8 months ago)
- Last Synced: 2024-12-27T19:44:04.488Z (5 months ago)
- Topics: commodore, commodore-component, projectsyn, storage, syn
- Language: Makefile
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Commodore Component: storage-local-static
This is a [Commodore][commodore] Component for storage-local-static.
This repository is part of Project Syn.
For documentation on Project Syn and this component, see [syn.tools](https://syn.tools).
## Documentation
The rendered documentation for this component is available on the [Commodore Components Hub](https://hub.syn.tools/storage-local-static).
Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].
It can be found in the [`docs`](docs) folder.
We use the [Divio documentation structure](https://documentation.divio.com/) to organize our documentation.
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 current state 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](LICENSE).
For information about how to contribute, see [CONTRIBUTING](CONTRIBUTING.md).
[commodore]: https://syn.tools/commodore/
[asciidoc]: https://asciidoctor.org/
[antora]: https://antora.org/