generated from openpeeps/pistachio
-
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.
- Loading branch information
0 parents
commit f52c3d9
Showing
4 changed files
with
107 additions
and
0 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,39 @@ | ||
name: docs | ||
on: | ||
push: | ||
tags: | ||
- '*.*.*' | ||
# branches: | ||
# - main | ||
env: | ||
nim-version: 'stable' | ||
nim-src: src/${{ github.event.repository.name }}.nim | ||
deploy-dir: .gh-pages | ||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: jiro4989/setup-nim-action@v1 | ||
with: | ||
nim-version: ${{ env.nim-version }} | ||
- run: nimble install -Y | ||
- run: nim doc --index:on --project --path:. --out:${{ env.deploy-dir }} ${{ env.nim-src }} | ||
|
||
- name: "Rename to index.html" | ||
run: mv ${{ env.deploy-dir }}/${{ github.event.repository.name }}.html ${{ env.deploy-dir }}/index.html | ||
|
||
- name: "Find and replace (index.html)" | ||
run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/index.html | ||
|
||
# - name: "Find and replace (idx)" | ||
# run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/${{ github.event.repository.name }}.idx | ||
|
||
- name: "Find and replace (theindex.html)" | ||
run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/theindex.html | ||
|
||
- name: Deploy documents | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ${{ env.deploy-dir }} |
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,30 @@ | ||
name: test | ||
on: | ||
push: | ||
paths-ignore: | ||
- LICENSE | ||
- README.* | ||
- examples | ||
- .github/workflows | ||
pull_request: | ||
paths-ignore: | ||
- LICENSE | ||
- README.* | ||
- examples | ||
- .github/workflows | ||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
nim-version: | ||
- 'stable' | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: jiro4989/setup-nim-action@v1 | ||
with: | ||
nim-version: ${{ matrix.nim-version }} | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
- run: nimble install -Y | ||
- run: nim c -r src/${{ github.event.repository.name }}.nim | ||
- run: nimble test |
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,8 @@ | ||
.DS_Store | ||
nimcache/ | ||
nimblecache/ | ||
htmldocs/ | ||
testresults/ | ||
/tests/* | ||
!/tests/*.nim | ||
!/tests/*.nims |
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,30 @@ | ||
<p align="center"> | ||
<img src="https://github.com/openpeeps/PKG/blob/main/.github/logo.png" width="90px"><br> | ||
OpenPeeps repository template for developing libraries,<br>projects and other cool things. π Written in Nim language | ||
</p> | ||
|
||
<p align="center"> | ||
<code>nimble install {PKG}</code> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/">API reference</a><br> | ||
<img src="https://github.com/openpeeps/pistachio/workflows/test/badge.svg" alt="Github Actions"> <img src="https://github.com/openpeeps/pistachio/workflows/docs/badge.svg" alt="Github Actions"> | ||
</p> | ||
|
||
## π Key Features | ||
- [x] Open Source | `MIT` License | ||
- [x] Written in Nim language | ||
|
||
## Examples | ||
... | ||
|
||
### β€ Contributions & Support | ||
- π Found a bug? [Create a new Issue](/issues) | ||
- π Wanna help? [Fork it!](/fork) | ||
- π [Get β¬20 in cloud credits from Hetzner](https://hetzner.cloud/?ref=Hm0mYGM9NxZ4) | ||
- π₯° [Donate via PayPal address](https://www.paypal.com/donate/?hosted_button_id=RJK3ZTDWPL55C) | ||
|
||
### π© License | ||
{PKG} | MIT license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).<br> | ||
Copyright © 2023 OpenPeeps & Contributors — All rights reserved. |