-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from FediMod/feat/intial-documentation-setup
Intial website & documentation setup
- Loading branch information
Showing
30 changed files
with
3,694 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Stop the editor from looking for .editorconfig files in the parent directories | ||
| root = true | ||
|
|
||
| [*] | ||
| # Non-configurable Prettier behaviors | ||
| charset = utf-8 | ||
| insert_final_newline = true | ||
| # Caveat: Prettier won’t trim trailing whitespace inside template strings, but your editor might. | ||
| trim_trailing_whitespace = true | ||
|
|
||
| # Configurable Prettier behaviors | ||
| # (change these if your Prettier config differs) | ||
| end_of_line = lf | ||
| indent_style = space | ||
| indent_size = 2 | ||
| # max_line_length = 80 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| name: Deploy Website | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| # with: | ||
| # fetch-depth: 0 # Not needed if lastUpdated is not enabled | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Install dependencies | ||
| run: npm ci | ||
| - name: Build with VitePress | ||
| run: npm run docs:build | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: docs/.vitepress/dist | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| name: Deploy | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,10 @@ | ||
| # Vitepress | ||
|
|
||
| .vitepress/cache | ||
| docs/.vitepress/dist | ||
| docs/.vitepress/cache | ||
|
|
||
|
|
||
| # Logs | ||
| logs | ||
| *.log | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| import { defineConfig } from "vitepress"; | ||
|
|
||
| // https://vitepress.dev/reference/site-config | ||
| export default defineConfig({ | ||
| title: "FediMod FIRES", | ||
| description: "Fediverse moderation Intelligence Replication Endpoint Server", | ||
| themeConfig: { | ||
| footer: { | ||
| message: | ||
| 'Released under the <a href="https://github.com/fedimod/fires/blob/main/LICENSE">AGPL License</a>.', | ||
| copyright: | ||
| 'Copyright © 2024 <a href="/contributors">FediMod FIRES Project</a>', | ||
| }, | ||
|
|
||
| // https://vitepress.dev/reference/default-theme-config | ||
| nav: [ | ||
| { text: "Home", link: "/" }, | ||
| { text: "Concepts", link: "/concepts/", activeMatch: "^/concepts" }, | ||
| { text: "Protocol Reference", link: "/reference/protocol/" }, | ||
| { text: "Conformance Tests", link: "/reference/testing/" }, | ||
| { | ||
| text: "Manuals", | ||
| items: [ | ||
| { | ||
| text: "Reference Server", | ||
| link: "/manuals/reference-server/", | ||
| }, | ||
| { | ||
| text: "Example Publisher", | ||
| link: "/manuals/example-publisher/", | ||
| }, | ||
| { | ||
| text: "Example Consumer", | ||
| link: "/manuals/example-consumer/", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
|
|
||
| sidebar: { | ||
| "/concepts/": [ | ||
| { | ||
| text: "Concepts", | ||
| link: "/concepts/", | ||
| items: [ | ||
| { | ||
| text: "Firewall-based Federation Management", | ||
| link: "/concepts/federation-firewalls", | ||
| }, | ||
| { text: "Labelling", link: "/concepts/labels" }, | ||
| { | ||
| text: "Advisories & Recommendations", | ||
| link: "/concepts/advisories-and-recommendations", | ||
| }, | ||
| { text: "Retractions", link: "/concepts/retractions" }, | ||
| ], | ||
| }, | ||
| { | ||
| text: "Project Background", | ||
| items: [ | ||
| { | ||
| text: "Introduction", | ||
| link: "/concepts/background/", | ||
| }, | ||
| { | ||
| text: "Goals & Objectives", | ||
| link: "/concepts/background/goals-and-objectives", | ||
| }, | ||
| { | ||
| text: "Historical Context", | ||
| link: "/concepts/background/historical-context", | ||
| }, | ||
| { | ||
| text: "Prior Art", | ||
| link: "/concepts/background/prior-art", | ||
| }, | ||
| { | ||
| text: "Why Not...?", | ||
| link: "/concepts/background/why-not", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| "/reference/": [ | ||
| { | ||
| text: "Reference", | ||
| items: [ | ||
| { | ||
| text: "Conformance Tests", | ||
| link: "/reference/testing/", | ||
| }, | ||
| { | ||
| text: "Protocol", | ||
| collapsed: true, | ||
| items: [ | ||
| { | ||
| text: "Introduction", | ||
| link: "/reference/protocol/", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
|
|
||
| "/manuals/reference-server": [ | ||
| { | ||
| text: "Reference Server", | ||
| items: [ | ||
| { | ||
| text: "Introduction", | ||
| link: "/manuals/reference-server/", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| "/manuals/example-publisher": [ | ||
| { | ||
| text: "Example Publisher", | ||
| items: [ | ||
| { | ||
| text: "Introduction", | ||
| link: "/manuals/example-publisher/", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| "/manuals/example-consumer": [ | ||
| { | ||
| text: "Example Consumer", | ||
| items: [ | ||
| { | ||
| text: "Introduction", | ||
| link: "/manuals/example-consumer/", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
|
|
||
| socialLinks: [ | ||
| { icon: "github", link: "https://github.com/fedimod/fires" }, | ||
| { icon: "mastodon", link: "https://mastodon.social/@fedimod" }, | ||
| ], | ||
| }, | ||
| }); |
Oops, something went wrong.