Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

This repository belongs to Semantic Data Structuring Working Group and it contains content to generate a documentation across different SDS repositories using Antora. The generated website is available under: https://openmanufacturingplatform.github.io/sds-documentation/

Notifications You must be signed in to change notification settings

OpenManufacturingPlatform/sds-documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

THIS REPOSITORY HAS BEEN ARCHIVED. Open Manufacturing Platform has been formally closed.

sds-documentation

This repository belongs to the Semantic Data Structuring Working Group (SDS WG) in the Open Manufacturing Platform. It contains content to generate a joint SDS WG documentation across different SDS WG repositories using Antora.

The documentation site is generated using Github actions and is available at https://openmanufacturingplatform.github.io/sds-documentation/.

As of now, the Antora build for the website pulls the content from the following repositories and sources:

Building locally

To build the documentation locally, you will need Node.js >=14. After installing, run the following commands:

# Installs the Antora CLI and the site generator
npm i @antora/cli@2.3 antora-site-generator-lunr

# Runs Antora to generate the documentation
./node_modules/@antora/cli/bin/antora --fetch site.yml --generator antora-site-generator-lunr

After that, the documentation is available at build/site/index.html.

About

This repository belongs to Semantic Data Structuring Working Group and it contains content to generate a documentation across different SDS repositories using Antora. The generated website is available under: https://openmanufacturingplatform.github.io/sds-documentation/

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published