generated from supranim/temple
-
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 52accbb
Showing
5 changed files
with
121 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,3 @@ | ||
nimcache/ | ||
nimblecache/ | ||
htmldocs/ |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Supranim | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,28 @@ | ||
<p align="center"> | ||
<img src="https://github.com/openpeeps/PKG/blob/main/.github/logo.png" width="90px"><br>Supranim template for developing cool packages & libraries.<br>👑 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/supranim/temple/workflows/test/badge.svg" alt="Github Actions"> <img src="https://github.com/supranim/temple/workflows/docs/badge.svg" alt="Github Actions"> | ||
</p> | ||
|
||
## 😍 Key Features | ||
- | ||
|
||
## Examples | ||
... | ||
|
||
### ❤ Contributions & Support | ||
- 🐛 Found a bug? [Create a new Issue](https://github.com/supranim/temple/issues) | ||
- 👋 Wanna help? [Fork it!](https://github.com/supranim/temple/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) for Supranim<br> | ||
Copyright © 2023 Supranim | OpenPeeps & Contributors — All rights reserved. |