CLI/

Build

commited date: 2025-04-26

❯ scraps build

This command processes Markdown files from the /scraps directory and generates a static website.

Source Structure

❯ tree scraps
scraps
├── Getting Started.md
└── What is Scraps?.md

Generated Files

The command generates the following files in the public directory:

❯ tree public
public
├── index.html      # Main page with scrap list
├── getting-started.html
├── what-is-scraps.html
├── main.css       # Styling for the site
└── search.json    # Search index (if enabled)

Each Markdown file is converted to a slugified HTML file. Additional files like index.html and main.css are generated to create a complete static website.

After building, use Serve to preview your site locally.

#CLI ❯ scraps init your-scraps-project ❯ cd your-scraps-project This command initializes a new Scraps project. It creates the following structure: ❯ tree -a -L 1 . ├── .gitignore # Git ignore patterns for Scraps projects ├── Config.toml # Project configuration file └── scraps # Directory for your Markdown files After initializing the project, proceed to Build to generate your static site.

Installation of Scraps. Init project. Edit the Configuration. Write Markdown files under the /scraps directory: Basic Markdown: CommonMark specification Extended features: GitHub-flavored Markdown Linking: Internal link, Context link, Tag link Build static site files. Serve the site for debugging. Deploy the site, for example using GitHub Pages.