Skip to content

Volumetrics-io/documentation

Repository files navigation

Documentation

Public documentation page

You will need pandoc installed. Check the version found in the render-build.sh file.

To build locally, just run smoo.sh.

./smoo.sh

The website will be built in the /public folder. Just serve this folder, or publish it to a CDN.


To add a document

  1. Add a markdown file in the source/docs/ folder
  2. Add the proper YAML data. Here's a boilerplate markdown:
--- 
title: "mr-a"
description: "The <mr-a> tag embeds a hyperlink in the interface of an <mr-panel>."
istag: true
---
# &lt;mr-a&gt;

The `<mr-a>`embeds a hyperlink in the UI of an `<mr-panel>`.

Official Publishing

Create a pr and once it gets merged into main, it will auto publish to the url in the github repo description.

About

Public documentation page

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages