This project introduces new team members to our service, with a flexible structure that can support broader use across the company.
FlatSatIntro serves as a guide for creating and maintaining documents with Quarto, making it easy to produce, manage, and update team documentation.
-
Install Quarto
Download and install Quarto from https://quarto.org. -
Install VS Code and Quarto Extension
Download Visual Studio Code and add the Quarto extension by searching for "Quarto" in the Extensions panel.
-
Start a New QMD Document
In VS Code, create a new.qmd
file, allowing Markdown and executable code for dynamic content. -
Use the Template
The Openscapes Quarto Website Tutorial provides a useful template to help structure your document. -
Rendering QMD Files
Render a file to the desired format (HTML, PDF, etc.) by running:quarto render yourfile.qmd
-
Edit the Index Page
Updateindex.qmd
for new content or changes to the site structure. -
Re-render the Index
Run:quarto render index.qmd
-
Preview Changes
View the output in a web browser or PDF viewer to confirm updates.
For improvements or feature requests, submit a pull request with a detailed description.