Telescope allows you to create a collaborative documentation that will be generated as a static site with an interactive graph to explore the content.
The project require Node.js 16+
- Clone this repository
- Install the dependencies using the command
npm install
Unlike a wiki where the pages have a hierarchy. In Telescope, we add cards in which we add the content. Each card is structured in a Markdown file to define its metadata. This will be used to generate the static HTML pages.
There are three types of cards: Resources, Authors and Tags. The main cards that is used to generate the graph are the resources. Authors and tags are automatically generated from the metadata of your resources.
A card template is available here
Add your content to the data/ressources
folder
The index.md
file in the data
folder is used to generate the index.html
file. Modify it to add the home page of your project.
- Be sure to change in
config.js
thebase_url
property to the URL of your website. - Build the static website using the command
npm run build
- Static HTML files are generated in the
dist
folder. Copy the content of this folder on your website.