Skip to content

Commit

Permalink
Links to stable/unstable docs
Browse files Browse the repository at this point in the history
Close #8
  • Loading branch information
dahlia committed Mar 13, 2024
1 parent 96168cf commit bcc40ff
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 6 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,26 @@ jobs:
- uses: denoland/setup-deno@v1
with:
deno-version: v1.x
- if: github.event_name == 'push' && github.ref_type == 'tag'
run: |
jq \
--arg url "$UNSTABLE_DOCS_URL" \
'.nav_links = [{"title":"Go to unstable","url":$url}] + .nav_links' \
_data.json > _data.json.tmp
mv _data.json.tmp _data.json
env:
UNSTABLE_DOCS_URL: ${{ vars.UNSTABLE_DOCS_URL }}
working-directory: ${{ github.workspace }}/docs/
- if: github.event_name != 'push' || github.ref_type != 'tag'
run: |
jq \
--arg url "$STABLE_DOCS_URL" \
'.nav_links = [{"title":"Go to stable","url":$url}] + .nav_links' \
_data.json > _data.json.tmp
mv _data.json.tmp _data.json
env:
STABLE_DOCS_URL: ${{ vars.STABLE_DOCS_URL }}
working-directory: ${{ github.workspace }}/docs/
- run: |
set -ex
jq \
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ The rough roadmap is to implement the following features out of the box:
If you want to know more about the project, please take a look at the following
resources:

- [JSR]
- [Manual](https://dahlia.github.io/fedify/manual/)
- [API reference](https://jsr.io/@fedify/fedify/doc)
- [Manual](https://fedify.dev/manual/)
([Unstable](https://unstable.fedify.dev/manual/))
- [API reference][JSR]
- [Examples](https://github.com/dahlia/fedify/tree/main/examples)

[^1]: You may already know some of the networks in the fediverse, such as
Expand Down
2 changes: 2 additions & 0 deletions docs/_config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ import image from "lume_markdown_plugins/image.ts";
import title from "lume_markdown_plugins/title.ts";
import lumocs from "lumocs/mod.ts";
import externalLinks from "npm:[email protected]";
import footnote from "npm:[email protected]";
import callouts from "npm:[email protected]";

const site = lume({}, {
markdown: {
plugins: [
footnote,
externalLinks,
callouts,
],
Expand Down
1 change: 1 addition & 0 deletions docs/_includes/head.njk
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ dd { margin-bottom: var(--typography-spacing-vertical); }
clear: left;
margin-top: 1rem;
}
.footnotes .footnotes-list * { font-size: 16px; }
</style>
{% if plausible_domain %}
<script
Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ If you want to know more about the project, please take a look at the following
resources:

- [GitHub](https://github.com/dahlia/fedify)
- [JSR](https://jsr.io/@fedify/fedify)
- [Manual](./manual.md)
- [API reference](https://jsr.io/@fedify/fedify/doc)
- [API reference](https://jsr.io/@fedify/fedify)
- [Examples](https://github.com/dahlia/fedify/tree/main/examples)

[^1]: You may already know some of the networks in the fediverse, such as
Expand Down
3 changes: 2 additions & 1 deletion mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
* following resources:
*
* - [GitHub](https://github.com/dahlia/fedify)
* - [Manual](./manual.md)
* - [Manual](https://fedify.dev/manual/)
* ([Unstable](https://unstable.fedify.dev/manual/))
* - [Examples](https://github.com/dahlia/fedify/tree/main/examples)
*
* [Deno]: https://deno.com/
Expand Down

0 comments on commit bcc40ff

Please sign in to comment.