-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation to gir.core repository
- Loading branch information
Showing
6 changed files
with
116 additions
and
8 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,55 @@ | ||
| name: Deploy documentation | ||
|
|
||
| on: | ||
| 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: | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
|
|
||
| - name: Prepare .NET | ||
| uses: actions/setup-dotnet@v4 | ||
| with: | ||
| dotnet-version: | | ||
| 6.0.x | ||
| 7.0.x | ||
| 8.0.x | ||
| - name: Call generator | ||
| run: dotnet fsi GenerateLibs.fsx | ||
| working-directory: './src' | ||
| - name: Restore solution | ||
| run: dotnet restore GirCore.Libs.slnf | ||
| working-directory: './src' | ||
|
|
||
| - name: Install docfx | ||
| run: dotnet tool update -g docfx | ||
| - name: Build website | ||
| run: docfx docs/docfx.json | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: './_site' | ||
| - 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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # GirCore Api Documentation | ||
| Please select the namespace you are interested in on the left side. |
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,39 @@ | ||
| { | ||
| "metadata": [ | ||
| { | ||
| "src": [ | ||
| { | ||
| "src": "../src/Libs", | ||
| "files": ["**/*.csproj"], | ||
| "exclude": ["GirTest-0.1/**"] | ||
| } | ||
| ], | ||
| "dest": "api" | ||
| } | ||
| ], | ||
| "build": { | ||
| "content": [ | ||
| { | ||
| "files": ["**/*.{md,yml}"], | ||
| "exclude": ["_site/**"] | ||
| } | ||
| ], | ||
| "resource": [ | ||
| { | ||
| "files": ["img/**"] | ||
| } | ||
| ], | ||
| "output": "../_site", | ||
| "template": [ | ||
| "default", | ||
| "modern" | ||
| ], | ||
| "globalMetadata": { | ||
| "_appName": "GirCore", | ||
| "_appTitle": "GirCore", | ||
| "_appLogoPath": "img/gircore-logo.svg", | ||
| "_enableSearch": true, | ||
| "pdf": false | ||
| } | ||
| } | ||
| } |
File renamed without changes.
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,19 +1,22 @@ | ||
| items: | ||
| - name: Home | ||
| href: ../index.md | ||
| href: index.md | ||
| - name: Api Documentation | ||
| href: api/ | ||
| homepage: api/index.md | ||
| - name: Use | ||
| items: | ||
| - name: Get started | ||
| href: use.md | ||
| href: docs/use.md | ||
| - name: Apps | ||
| href: apps.md | ||
| href: docs/apps.md | ||
| - name: Libraries | ||
| href: libraries.md | ||
| href: docs/libraries.md | ||
| - name: Contribute | ||
| items: | ||
| - name: Guidelines | ||
| href: contributing.md | ||
| href: docs/contributing.md | ||
| - name: Build | ||
| href: build.md | ||
| href: docs/build.md | ||
| - name: Github | ||
| href: https://github.com/gircore/ |
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