Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: revamp documentation site #4078

Merged
merged 2 commits into from
Mar 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
33 changes: 33 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Deploy Docs to GitHub Pages

on:
push:
branches: [main]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: 📚 Git Checkout
uses: actions/checkout@v4

- name: 📦 Build Site
uses: withastro/action@v2
with:
path: ./docs

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: 🚀 Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
24 changes: 24 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store

# firebase
.firebase
Empty file removed docs/.nojekyll
Empty file.
23 changes: 23 additions & 0 deletions docs/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"printWidth": 100,
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": true,
"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": [".*", "*.json", "*.md", "*.toml", "*.yml"],
"options": {
"useTabs": false
}
},
{
"files": ["*.md", "*.mdx"],
"options": {
"printWidth": 80
}
}
]
}
45 changes: 0 additions & 45 deletions docs/_coverpage.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/_footer.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

54 changes: 0 additions & 54 deletions docs/_js/update-pubspec.js

This file was deleted.

12 changes: 0 additions & 12 deletions docs/_navbar.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/_sidebar.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/_snippets/angular_counter_tutorial/app_component.dart.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_snippets/angular_counter_tutorial/install.sh.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/_snippets/angular_counter_tutorial/pubspec.yaml.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_snippets/angular_counter_tutorial/stagehand.sh.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/_snippets/architecture/bloc_to_bloc_communication.dart.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_snippets/architecture/data_provider.dart.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_snippets/architecture/presentation_component.dart.md

This file was deleted.

Loading