diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index de4ac33..362ca4c 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -40,4 +40,26 @@ jobs: - name: push packages if: github.event_name == 'push' && github.ref == 'refs/heads/master' - run: dotnet nuget push **/*.nupkg -s https://f.feedz.io/davidfowl/featherhttp/nuget/index.json -ss https://f.feedz.io/davidfowl/featherhttp/symbols --skip-duplicate \ No newline at end of file + run: dotnet nuget push **/*.nupkg -s https://f.feedz.io/davidfowl/featherhttp/nuget/index.json -ss https://f.feedz.io/davidfowl/featherhttp/symbols --skip-duplicate + + generate-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + persist-credentials: false + - name: generate gh-pages + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + run: | + cd ./docs + npm install + npm run generate:gh-pages + - name: deploy + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + uses: JamesIves/github-pages-deploy-action@releases/v3 + with: + ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} + BRANCH: gh-pages + FOLDER: docs/dist + CLEAN: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index 427adc7..da80b9b 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,8 @@ BenchmarkDotNet.Artifacts/ .gradle/ src/SignalR/clients/**/dist/ modules/ +.nuxt/ +dist/ # File extensions *.aps diff --git a/docs/.editorconfig b/docs/.editorconfig new file mode 100644 index 0000000..5d12634 --- /dev/null +++ b/docs/.editorconfig @@ -0,0 +1,13 @@ +# editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/docs/.prettierrc b/docs/.prettierrc new file mode 100644 index 0000000..b2095be --- /dev/null +++ b/docs/.prettierrc @@ -0,0 +1,4 @@ +{ + "semi": false, + "singleQuote": true +} diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..a78cd1e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,115 @@ +# Docs contribution guide + +## How to Contribute + +This project uses [Nuxt](https://nuxtjs.org/) which is a static site generator. + +You will need to install [nodejs](https://nodejs.org/). +You can get the project running these commands from the `\docs` directory. + +``` bash + #install the projects from npm + npm install + + #serve the project with hot reload from localhost:3000 + npm run dev + + #if you want to see what files will be output for the static site then + npm run generate + + #if, from your fork, you'd like to generate the docs site so you can see how it will look on github pages then you can run these commands: + npm run generate:gh-pages + npm run deploy +``` + +There are several ways you may want to contribute to the docs. + +1. Add to the existing docs. +2. Create a brand new doc + +### Add to the existing docs + +Adding to the existing docs is easy. +First, in pages/examples find the .vue file that contains the documentation you seek to modify. +Then within the template tags you can make your modifications. + +``` html + +``` + +You can optionally make contributions in regular html by removing `lang="md"` from the `