Skip to content

openresearch/eclipse-tractusx.github.io

 
 

Repository files navigation

Eclipse-tractusx website

This website is built using Docusaurus 2, a modern static website generator.

How to deploy

This deploys through GitHub actions!

How to use locally

To use this site locally and see your doc rendered as website, just use the following commands.

  • npm install (only initially needed)
  • npm start

This will install all dependencies necessary and run the website on http://localhost:3000/.

Linting

We do want to follow a specific style for our markdown based documentation. Therefore, this repository is configured to use a markdown linter. Specific rules are configured via .markdownlint.yaml.

Additionally, there is a npm script lint-doc, that will lint all the markdown files inside docs. This script is also run as a pre-commit hook, set up via husky. You can also run the linting step manually by running npm run lint-doc.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 73.4%
  • CSS 26.5%
  • Shell 0.1%