Scraps Doc

#Integration Currently, the most recommended LSP for editing Scraps is markdown-oxide. markdown-oxide supports the following editing environments: Neovim VSCode Zed Helix To match the current features provided by Scraps, place the following configuration file .moxide.toml under the scraps/ directory and open the scraps/ directory directly for a comfortable editing experience. heading_completions = false title_headings = false tags_in_codeblocks = false references_in_codeblocks = false We are considering a feature to generate the LSP configuration file during the init command.

#CLI ❯ scraps mcp serve This command starts an MCP (Model Context Protocol) server that enables AI assistants like Claude Code to directly interact with your Scraps knowledge base. Examples # Basic MCP server ❯ scraps mcp serve # Serve from specific directory ❯ scraps mcp serve --path /path/to/project The MCP server provides tools for AI assistants to search through your content and list available tags, enabling intelligent assistance with your documentation. For more details, see Integrate with AI Assistants.

#Wiki-Links #Markdown If there is no scrap with the specified title, such as #Markdown, it becomes a tag. Tags are displayed on the index page. Each tag links to a page that lists all scraps using that tag.

#CLI ❯ scraps tag This command lists all tags found in your Scraps content, helping you understand the tag distribution across your knowledge base. Examples # List all tags ❯ scraps tag # List tags from specific directory ❯ scraps tag --path /path/to/project

#Wiki-Links #Markdown Specifying the name of the markdown file with a notation such as [[Link]] will generate a wiki-like internal link. For example, if you have the following set of files. ❯ tree scraps scraps ├── Overview.md └── Usage.md Fill in the file name in the scraps directory in Overview.md as follows to generate the link. See [[Usage]] for detail.

#Wiki-Links #Markdown In cases where the same term exists in different contexts and Scrap titles would overlap, you can use the context feature by separating them with folders. For example: ❯ tree scraps scraps ├── DDD │ └── Service.md └── Kubernetes └── Service.md Links to Scrap with different contexts can be specified like [[DDD/Service]], [[Kubernetes/Service]]. You can also combine them with Alias link such as [[Kubernetes/Service|Kubernetes Service]]. The context is also displayed on the Scrap detail page in the static site. Not Recommended Scraps aims for simple knowledge management, so overuse of folders should be avoided. Use folders (Context) only in cases such as: When duplicate Scrap titles occur across different contexts When a Scrap has a strong association with a specific context

#Wiki-Links #Markdown Internal links allow you to use different display text as aliases. Writing [[Markdown|here]] creates a link that displays as here but links to the “Markdown” page.

#CLI ❯ scraps serve This command starts a local development server to preview your static site. The server automatically serves the files from the public directory at http://127.0.0.1:1112. Examples # Basic serve ❯ scraps serve # Serve from specific directory ❯ scraps serve --path /path/to/project Use this command to check how your site looks and functions before deployment.