Setup
Install Scraps
- Follow the Installation guide to install Scraps on your system
Initialize Project
- Create a new Scraps project using Init:
❯ scraps init my-knowledge-base ❯ cd my-knowledge-base
- Create a new Scraps project using Init:
Configure Project
- Customize the Configuration in
Config.toml
- Set your site title, base URL, and other preferences
- Customize the Configuration in
Content Creation
Write Markdown Files
- Create Markdown files in the
/scraps
directory - Use CommonMark specification and GitHub-flavored Markdown
- Create Markdown files in the
Add Internal Links
- Connect documents using Internal Link syntax:
[[Page Name]]
for simple links[[Page Name|Custom Text]]
for custom link text
- Connect documents using Internal Link syntax:
Enhance Content
- Add Mermaid diagrams for visual representations
- Use Autolink functionality for external links
- Organize with context folders when needed
Build and Preview
Generate Site
- Use Build to generate static site files:
❯ scraps build
- Use Build to generate static site files:
Preview Locally
- Use Serve for local preview and debugging:
❯ scraps serve
- Use Serve for local preview and debugging:
Deploy
- Deploy to platforms like GitHub Pages when ready