mirror of
https://github.com/tt-rss/tt-rss.github.io.git
synced 2026-09-18 14:11:46 +00:00
supahgreg
4862e509af
These are just to help notify users, who might otherwise be unaware, of the project changes that've occurred. Older tt-rss versions will poll https://tt-rss.org/plugins.json and https://tt-rss.org/version.json, while newer versions will use https://tt-rss.org/tt-rss/plugins.json and https://tt-rss.org/tt-rss/version.json (due to how the workflow is set up in tt-rss/tt-rss).
Tiny Tiny RSS Documentation Site
This repository contains the source for https://tt-rss.org.
Contributing
Contributions to improve the documentation are welcome! See CONTRIBUTING.md for guidelines.
By contributing, you agree that your contributions will be licensed under CC BY-SA 4.0 (see License below).
Structure
/
├── _config.yml # Jekyll configuration
├── index.md # Homepage
├── docs/ # Documentation pages
├── images/ # Screenshots and images
├── LICENSE # CC BY-SA 4.0 license
├── CONTRIBUTING.md # Contribution guidelines
└── README.md # This file
Building Locally
This is a Jekyll-based GitHub Pages site. To build locally:
# Install dependencies
bundle install
# Run local server
bundle exec jekyll serve
# View at http://localhost:4000
Useful Links
- Documentation Repository: https://github.com/tt-rss/tt-rss.org
- Documentation Site: https://tt-rss.org
- Main Repository: https://github.com/tt-rss/tt-rss
- Discussions: https://github.com/tt-rss/tt-rss/discussions
- Issues: https://github.com/tt-rss/tt-rss/issues
License
Documentation Content
The documentation and site content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0).
You are free to:
- Share and redistribute the documentation
- Adapt and build upon the documentation
Under these terms:
- Attribution — Give appropriate credit and link to the license
- ShareAlike — Distribute adaptations under the same CC BY-SA 4.0 license
Tiny Tiny RSS
The tt-rss software itself is licensed under the GNU General Public License v3.0 (GPLv3).
Any code snippets or configuration examples derived from tt-rss retain their original GPLv3 license.