Cirro Guides for anyone - business or developer - to learn about Cirro and how to use it. This is a Next.js project using Tailwind CSS and Markdoc.
To write content for the Cirro Guides, you need to have a basic understanding of Markdown (more precisely Markdoc) and Git. If you are not familiar with these, please read the following guides:
You will find all the content in the src folder. The content is written in Markdown and is organized in folders and files. The folder structure is as follows:
├── src
│ ├── pages # Markdown files for the pages
│ ├── images # Images for the pages
│ ├── data # Sidebar navigation linksIf you want to embed code snippets, you can use the following syntax:
{% code language="ruby" showLineNumbers=true %}
```
x = 7.days.ago
```
{% /code %}All pages by default show a table of contents on the right. You can disable this by adding hideTableOfContents: true to the frontmatter of the page:
---
title: "Page Title"
hideTableOfContents: true
---This will expand the content to the full width of the page.
To contribute to the Cirro Guides application (this repository), you need to have a basic understanding of JavaScript (Next.js), Markdoc, TailwindCSS, and Yarn. Git(Hub) proficiency is presumed. If you are not familiar with these, please read the following guides:
To get started, first run bin/setup. This will install all dependencies and set up the project. Then run yarn dev to start the development server. You can now access the application at http://localhost:3000.
To run the linter, run bin/lint. This requires markdownlint to be installed. To install it via Homebrew, run brew install markdownlint-cli.
The search is powered by Algolia. The search index is updated by running a crawler on the deployed guides. This crawler is Python based and lives in its own (private) repository. All instructions on how to run the crawler can be found in that repositories README.
👤 Jan Schwenzien