Skip to content

Commit 3cdd1b8

Browse files
supahgregsupahgreg
committed
Initial commit
0 parents  commit 3cdd1b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2425
-0
lines changed

‎.github/dependabot.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: github-actions
5+
directory: /
6+
schedule:
7+
interval: weekly
8+
commit-message:
9+
prefix: 'GitHub Actions:'
10+
groups:
11+
github-actions:
12+
patterns:
13+
- '*'
14+
15+
- package-ecosystem: bundler
16+
directory: /
17+
schedule:
18+
interval: weekly
19+
commit-message:
20+
prefix: 'Bundler:'
21+
groups:
22+
bundler:
23+
patterns:
24+
- '*'

‎.github/workflows/lint.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
# Allow manual triggering
9+
workflow_dispatch:
10+
# Allow other workflows (e.g. Pages) to invoke this one.
11+
workflow_call:
12+
13+
permissions:
14+
contents: read
15+
statuses: write
16+
17+
jobs:
18+
super-linter:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Run Super-Linter
27+
uses: super-linter/super-linter/slim@v7
28+
env:
29+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30+
DEFAULT_BRANCH: main
31+
# Validate all files on push/workflow_dispatch, only changed files on PRs
32+
VALIDATE_ALL_CODEBASE: ${{ github.event_name != 'pull_request' }}
33+
VALIDATE_MARKDOWN: true
34+
VALIDATE_YAML: true

‎.github/workflows/pages.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Build and deploy Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
11+
concurrency:
12+
group: pages
13+
cancel-in-progress: false
14+
15+
jobs:
16+
lint:
17+
uses: ./.github/workflows/lint.yml
18+
permissions:
19+
contents: read
20+
statuses: write
21+
22+
build-and-deploy:
23+
runs-on: ubuntu-latest
24+
needs: lint
25+
permissions:
26+
contents: read
27+
pages: write
28+
id-token: write
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 0
34+
35+
- name: Setup Ruby
36+
uses: ruby/setup-ruby@v1
37+
with:
38+
bundler-cache: true
39+
40+
- name: Build Jekyll site
41+
run: bundle exec jekyll build --destination ./_site
42+
43+
- name: Configure GitHub Pages
44+
uses: actions/configure-pages@v5
45+
46+
- name: Upload Pages artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: ./_site
50+
51+
- name: Deploy to GitHub Pages
52+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Jekyll generated site
2+
_site/
3+
.jekyll-cache/
4+
.jekyll-metadata
5+
6+
# Ruby / Bundler
7+
.bundle/
8+
vendor/bundle/
9+
*.gem
10+
Gemfile.lock
11+
12+
# Node
13+
node_modules/
14+
package-lock.json
15+
16+
# Environment and secrets
17+
.env
18+
.env.local
19+
20+
# OS files
21+
.DS_Store
22+
Thumbs.db
23+
24+
# Editor / IDE
25+
.vscode/
26+
.idea/
27+
*.swp
28+
*.swo
29+
*~
30+
31+
# Logs
32+
*.log

‎.ruby-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.3

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to tt-rss Documentation
2+
3+
Thank you for your interest in contributing to the Tiny Tiny RSS documentation!
4+
5+
## How to Contribute
6+
7+
* Contributions (documentation corrections/improvements, reporting issues, etc.) are welcome.
8+
* Development and issue tracking for tt-rss primarily happens at [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss).
9+
10+
## Documentation License
11+
12+
By contributing to this repository, you agree that your contributions will be licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).
13+
14+
This means:
15+
- Your contributions can be freely shared and adapted by others
16+
- Proper attribution will be given
17+
- Derivative works must be shared under the same license
18+
19+
## Guidelines
20+
21+
When contributing documentation:
22+
23+
1. **Be clear and concise** - Write for users of all skill levels
24+
2. **Test your examples** - Ensure code snippets and commands work as described
25+
3. **Cite sources** - If including third-party content, state its source and license in your pull request
26+
4. **Stay current** - tt-rss follows a continuous development model on the `main` branch, so the documentation needs to be kept current
27+
5. **Check formatting** - Use proper Markdown formatting and verify links work
28+
29+
## Questions?
30+
31+
If you're unsure about including third-party content or have questions about licensing, please ask in your pull request or open a discussion.
32+
33+
Thank you for helping improve tt-rss documentation!

‎Gemfile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
source "https://rubygems.org"
2+
3+
gem "github-pages", group: :jekyll_plugins
4+
gem "jekyll-remote-theme"
5+
gem "webrick", "~> 1.7"

‎LICENSE‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
2+
3+
Copyright (c) 2025 tt-rss (https://github.com/tt-rss)
4+
5+
This documentation and site content is licensed under the Creative Commons
6+
Attribution-ShareAlike 4.0 International License.
7+
8+
To view a copy of this license, visit:
9+
https://creativecommons.org/licenses/by-sa/4.0/
10+
11+
or send a letter to:
12+
Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
13+
14+
---
15+
16+
You are free to:
17+
18+
Share — copy and redistribute the material in any medium or format
19+
Adapt — remix, transform, and build upon the material for any purpose,
20+
even commercially.
21+
22+
Under the following terms:
23+
24+
Attribution — You must give appropriate credit, provide a link to the
25+
license, and indicate if changes were made. You may do so
26+
in any reasonable manner, but not in any way that suggests
27+
the licensor endorses you or your use.
28+
29+
ShareAlike — If you remix, transform, or build upon the material, you
30+
must distribute your contributions under the same license
31+
as the original.
32+
33+
No additional restrictions — You may not apply legal terms or technological
34+
measures that legally restrict others from doing
35+
anything the license permits.
36+
37+
---
38+
39+
NOTICE:
40+
41+
This license applies to the documentation content in this repository.
42+
The Tiny Tiny RSS software itself is licensed under the GNU General Public
43+
License v3.0 (GPLv3). See https://github.com/tt-rss/tt-rss for software licensing.
44+
45+
Any code snippets, configuration examples, or other software-related content
46+
derived from the tt-rss repository retain their original GPLv3 license.
47+
48+
Third-party content (if any) retains its original license and attribution.

‎README.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Tiny Tiny RSS Documentation Site
2+
3+
This repository contains the source for the https://tt-rss.github.io.
4+
5+
## License
6+
7+
### Documentation Content
8+
9+
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)](LICENSE).
10+
11+
**You are free to:**
12+
- Share and redistribute the documentation
13+
- Adapt and build upon the documentation
14+
15+
**Under these terms:**
16+
- **Attribution** — Give appropriate credit and link to the license
17+
- **ShareAlike** — Distribute adaptations under the same CC BY-SA 4.0 license
18+
19+
### Tiny Tiny RSS
20+
21+
The tt-rss software itself is licensed under the [GNU General Public License v3.0 (GPLv3)](https://github.com/tt-rss/tt-rss/blob/master/COPYING).
22+
23+
Any code snippets or configuration examples derived from tt-rss retain their original GPLv3 license.
24+
25+
## Contributing
26+
27+
Contributions to improve the documentation are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
28+
29+
By contributing, you agree that your contributions will be licensed under CC BY-SA 4.0.
30+
31+
## Building Locally
32+
33+
This is a Jekyll-based GitHub Pages site. To build locally:
34+
35+
```bash
36+
# Install dependencies
37+
bundle install
38+
39+
# Run local server
40+
bundle exec jekyll serve
41+
42+
# View at http://localhost:4000
43+
```
44+
45+
## Structure
46+
47+
```
48+
tt-rss.github.io/
49+
├── _config.yml # Jekyll configuration
50+
├── index.md # Homepage
51+
├── docs/ # Documentation pages
52+
├── images/ # Screenshots and images
53+
├── LICENSE # CC BY-SA 4.0 license
54+
├── CONTRIBUTING.md # Contribution guidelines
55+
└── README.md # This file
56+
```
57+
58+
## Use Links
59+
60+
- **Documentation Repository:** [https://github.com/tt-rss/tt-rss.github.io](https://github.com/tt-rss/tt-rss.github.io)
61+
- **Documentation Site:** [https://tt-rss.github.io](https://tt-rss.github.io)
62+
- **Main Repository:** [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss)
63+
- **Discussions:** [https://github.com/tt-rss/tt-rss/discussions](https://github.com/tt-rss/tt-rss/discussions)
64+
- **Issues:** [https://github.com/tt-rss/tt-rss/issues](https://github.com/tt-rss/tt-rss/issues)
65+

‎_config.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
title: Tiny Tiny RSS Documentation
2+
description: Documentation for tt-rss, a free and open source web-based news feed reader
3+
remote_theme: just-the-docs/just-the-docs
4+
baseurl: ""
5+
url: "https://tt-rss.github.io"
6+
7+
# Just the Docs theme settings
8+
color_scheme: light
9+
search_enabled: true
10+
search:
11+
heading_level: 2
12+
previews: 3
13+
preview_words_before: 5
14+
preview_words_after: 10
15+
16+
# Heading anchor links
17+
heading_anchors: true
18+
19+
# Footer content
20+
footer_content: 'Documentation licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>. tt-rss software licensed under <a href="https://www.gnu.org/licenses/gpl-3.0.html">GPLv3</a>.'
21+
22+
# Back to top link
23+
back_to_top: true
24+
back_to_top_text: "Back to top"
25+
26+
# External links in header
27+
aux_links:
28+
"tt-rss on GitHub":
29+
- "https://github.com/tt-rss/tt-rss"
30+
"Discussions":
31+
- "https://github.com/tt-rss/tt-rss/discussions"
32+
"Report Issue":
33+
- "https://github.com/tt-rss/tt-rss/issues"
34+
35+
# Markdown settings
36+
markdown: kramdown
37+
kramdown:
38+
syntax_highlighter_opts:
39+
block:
40+
line_numbers: false
41+
42+
# Exclude from processing
43+
exclude:
44+
- README.md
45+
- CONTRIBUTING.md
46+
- LICENSE
47+
- Gemfile
48+
- Gemfile.lock
49+
- node_modules
50+
- vendor

0 commit comments

Comments
 (0)