Web docs (#106)

* Add docusaurus doc (WIP) * Improve lints structuring in docs * Styling * Widen the sidebar (fix text overflow) * Add comment for the sidebar fix * Revert "Merge branch 'master' into web-docs" This reverts commit d229735, reversing changes made to 1bd291e. * merge "docusaurus-web-docs" * Docusaurus web docs (#103) * added documentation parser for docusaurus * ghpages config * workflow files * github pages deployment * rm .idea * Delete doc/docusaurus/deploy-docs.sh * rm solid_lints.iml * ignore generated * added files that were accidentally lost during rebases * made parser executable * make sortRulesAlphabetically parameter not required * suggestions applied * merged "master" * add build documentation job * documentation autodeployment * restore docs * rm unnecessary argument * DocusaurusFormatter doc comment * move utils to src folder * rm unnecessary sort-rules parameter * Update dependencies (#107) * Doc cleanup (#108) * add rationale docs * move generated docs * Update site header * Use full arg names * fix themes, add dart syntax highlighting * rm custom path prefix * More serious tagline on frontpage * Update .github/workflows/gh-pages-deploy.yaml --------- Co-authored-by: Daniil Marchenko <[email protected]> * Ordering improvements * reduce nesting under rationale/custom_lint * Deployment fixes * Flatten structure * better headings * overviews and headers * intro.md metadata * changed path to images * use custom flow for gh pages --------- Co-authored-by: Yurii Prykhodko <[email protected]> Co-authored-by: Yurii Prykhodko <[email protected]> Co-authored-by: Yurii Prykhodko <[email protected]>
solid-software · Jan 25, 2024 · d6ae746 · d6ae746
1 parent 1bf6653
commit d6ae746
Show file tree

Hide file tree

Showing 67 changed files with 9,596 additions and 1,107 deletions.
diff --git a/.github/workflows/gh-pages-deploy.yaml b/.github/workflows/gh-pages-deploy.yaml
@@ -0,0 +1,90 @@
+name: Build and Deploy documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Generate docs content
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+
+      - name: Install Dependencies
+        run: dart pub get
+
+      - name: Generate documentation files
+        run: >
+          dart run bin/generate_web_docs_content.dart
+          --path lib/lints
+          --docs-dir doc/docusaurus/docs/generated
+          --readme README.md
+
+      - name: Create generated docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: generated-docs
+          path: doc/docusaurus/docs
+
+  deploy:
+    needs: build
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: doc/docusaurus
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: doc/docusaurus/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Download generated docs
+        uses: actions/download-artifact@v4
+        with:
+          name: generated-docs
+          path: doc/docusaurus/docs
+
+      - name: Build website
+        run: yarn build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: doc/docusaurus/build
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2