https://github.com/calconnect/cc-lightweight-doc
https://github.com/calconnect/cc-lightweight-doc
metanorma-release
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/calconnect/cc-lightweight-doc
- Owner: CalConnect
- Created: 2020-06-15T14:51:16.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-05-22T09:06:56.000Z (about 1 month ago)
- Last Synced: 2026-05-22T15:59:00.494Z (about 1 month ago)
- Topics: metanorma-release
- Language: Ruby
- Size: 5.73 MB
- Stars: 2
- Watchers: 20
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= CalConnect Standard: Lightweight document -- Document metamodel
This work item belongs to TC VCARD.
image:https://travis-ci.com/CalConnect/csd-lightweight-doc.svg?branch=master["Build Status", link="https://travis-ci.com/calconnect/csd-lightweight-doc"]
This document is available in its rendered forms here:
* https://calconnect.github.io/csd-lightweight-doc/[CC/ISO: Lightweight document -- Document metamodel (HTML)]
== Fetching the document
[source,sh]
----
git clone https://github.com/CalConnect/csd-lightweight-doc/
----
== 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
version by:
[source,sh]
----
export METANORMA_DOCKER=1
----
The `Makefile` will automatically choose the proper command to
execute.
== Building The Document
[source,sh]
----
make clean all
----
The following outputs will be built:
* CSD XML (https://github.com/calconnect/metanorma-model-csd) (`[filename].xml`)
* HTML (`[filename].html`)
* PDF (`[filename].pdf`)
* Word DOC (`[filename].doc`)
== Iterating the document
[source,sh]
----
make html
open cc-*.html
----