-
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
Showing
5 changed files
with
149 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,46 @@ | ||
name: generate | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
container: | ||
image: metanorma/metanorma:latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Cache Metanorma assets | ||
uses: actions-mn/cache@v1 | ||
|
||
- name: Metanorma generate site | ||
uses: actions-mn/build-and-publish@main | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
agree-to-terms: true | ||
|
||
deploy: | ||
if: ${{ github.ref == 'refs/heads/main' }} | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- 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,9 @@ | ||
.DS_Store | ||
*.abort | ||
*.err | ||
relaton/ | ||
.vscode/ | ||
.ruby-lsp/ | ||
Gemfile.lock | ||
iev/ | ||
_site/ |
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 @@ | ||
source "https://rubygems.org" | ||
|
||
gem "metanorma-cli" |
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,80 @@ | ||
= CalConnect Standard: (TITLE) | ||
|
||
This work item belongs to CalConnect (TCs). | ||
|
||
image:https://github.com/CalConnect/cc-iTip-rewrite/workflows/generate/badge.svg["Build Status", link="https://github.com/CalConnect/cc-iTip-rewrite/actions?workflow=generate"] | ||
|
||
This document is available in its rendered forms here: | ||
|
||
* https://calconnect.github.io/cc-iTip-rewrite/[CalConnect: Calendaring and scheduling -- Vocabulary (HTML)] | ||
== General | ||
|
||
This document specifies the (TITLE). | ||
|
||
The document is published as the following: | ||
|
||
* CalConnect CC (DOCNUMBER) | ||
* ISO (DOCNUMBER) | ||
* IETF draft-cc-iTip-rewrite | ||
|
||
|
||
== Fetching the document | ||
|
||
[source,sh] | ||
---- | ||
git clone https://github.com/CalConnect/cc-iTip-rewrite/ | ||
---- | ||
|
||
|
||
== Installing build tools | ||
|
||
See https://www.metanorma.com/author/topics/install/ | ||
|
||
|
||
== Running via Docker or locally | ||
|
||
If you have installed the build tools locally, and wish to run the | ||
locally-installed compilation tools, there is nothing further to set. | ||
|
||
If you don't want to deal with local dependencies, use the docker: | ||
|
||
[source,sh] | ||
---- | ||
docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate --agree-to-terms | ||
---- | ||
|
||
|
||
== Building the document | ||
|
||
[source,sh] | ||
---- | ||
metanorma site generate --agree-to-terms | ||
---- | ||
|
||
The generated documents are accessible under `_site/`. | ||
|
||
|
||
== Iterating the document | ||
|
||
[source,sh] | ||
---- | ||
metanorma site generate --agree-to-terms | ||
open _site/index.html | ||
---- | ||
|
||
|
||
// == IETF: Checking against idnits | ||
|
||
// https://tools.ietf.org/tools/idnits/[idnits] is the RFC checking tool prior to | ||
// submissions. | ||
|
||
// [source,sh] | ||
// ---- | ||
// idnits draft-calconnect-vobject-vformat.nits | ||
// ---- | ||
|
||
|
||
== License | ||
|
||
Copyright its respective authors and CalConnect. |
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,11 @@ | ||
--- | ||
metanorma: | ||
source: | ||
files: | ||
- sources/cc-51008/document.adoc | ||
- sources/ietf/document.adoc | ||
- sources/iso-51008/document.adoc | ||
|
||
collection: | ||
name: vObject and vFormat | ||
organization: CalConnect |