@mgks/docmd 0.3.1 → 0.3.3

package/docs/content/containers/callouts.md

@@ -1,154 +0,0 @@
----
-title: "Container: Callouts"
-description: "How to use callouts to highlight important information, warnings, tips, or notes in your documentation."
----
-
-# Callouts
-
-Callouts are perfect for drawing the user's attention to a specific piece of information. They are visually distinct from the regular text and are ideal for tips, warnings, and important notes.
-
-## Usage
-
-The basic syntax uses the `callout` container name, followed by the callout type.
-
-::: callout info
-Container blocks (like `::: callout`) should be preceded by a blank line to ensure proper parsing by the markdown processor.
-:::
-
-**Syntax:**
-```markdown
-::: callout type
-The main content of the callout.
-:::
-```
-
-**With Custom Title:**
-```markdown
-::: callout type Custom Title Here
-The main content of the callout.
-:::
-```
-
-**Parameters:**
-*   `type`: The type determines the color and styling of the callout. Available types are: `info`, `tip`, `warning`, `danger`, `success`.
-*   `Custom Title Here` (optional): Any text following the type becomes the callout title.
-
-::: callout info Auto Emojis
-Some themes (like Sky) automatically add emojis to callout titles: ℹ️ for info, ⚠️ for warning, 💡 for tip, 🚨 for danger, and ✅ for success.
-:::
-
----
-
-## Examples
-
-### Info
-
-Use the `info` type for general notes or neutral supplementary details.
-
-**Code:**
-```markdown
-::: callout info
-This is an informational message. It's great for providing context or background information that is helpful but not critical.
-:::
-```
-
-**Rendered Preview:**
-::: callout info
-This is an informational message. It's great for providing context or background information that is helpful but not critical.
-:::
-
-**With Custom Title:**
-```markdown
-::: callout info Quick Reference
-This callout has a custom title that appears prominently at the top.
-:::
-```
-
-**Rendered Preview:**
-::: callout info Quick Reference
-This callout has a custom title that appears prominently at the top.
-:::
-
-### Tip
-
-Use the `tip` type for helpful tips, best practices, or suggestions.
-
-**Code:**
-```markdown
-::: callout tip
-Here's a helpful tip to improve your workflow. Using this shortcut can save you a lot of time!
-:::
-```
-
-**Rendered Preview:**
-::: callout tip
-Here's a helpful tip to improve your workflow. Using this shortcut can save you a lot of time!
-:::
-
-**With Custom Title:**
-```markdown
-::: callout tip Pro Tip
-Custom titles help organize your callouts and make them more scannable for readers.
-:::
-```
-
-**Rendered Preview:**
-::: callout tip Pro Tip
-Custom titles help organize your callouts and make them more scannable for readers.
-:::
-
-### Warning
-
-Use the `warning` type to indicate something that requires caution or might lead to unexpected results.
-
-**Code:**
-```markdown
-::: callout warning
-**Heads up!** Changing this setting can have unintended side effects. Please make sure you understand the consequences before proceeding.
-:::
-```
-
-**Rendered Preview:**
-::: callout warning
-**Heads up!** Changing this setting can have unintended side effects. Please make sure you understand the consequences before proceeding.
-:::
-
-### Danger
-
-Use the `danger` type for critical information, destructive actions, or security warnings.
-
-**Code:**
-```markdown
-::: callout danger
-**Critical!** This action is irreversible and will result in permanent data loss. Do not proceed unless you have a backup.
-:::
-```
-
-**Rendered Preview:**
-::: callout danger
-**Critical!** This action is irreversible and will result in permanent data loss. Do not proceed unless you have a backup.
-:::
-
-## All Callout Types with Titles
-
-Here's a quick reference showing all available callout types with custom titles:
-
-::: callout info Documentation Note
-Use info callouts for neutral supplementary information.
-:::
-
-::: callout tip Best Practice
-Use tip callouts for helpful suggestions and best practices.
-:::
-
-::: callout warning Important
-Use warning callouts for actions that require caution.
-:::
-
-::: callout danger Critical Alert
-Use danger callouts for destructive actions or critical warnings.
-:::
-
-::: callout success Task Complete
-Use success callouts to indicate completed tasks or positive outcomes.
-:::

package/docs/content/containers/cards.md

@@ -1,93 +0,0 @@
----
-title: "Container: Cards"
-description: "How to use cards to group related content into visually distinct blocks with an optional title."
----
-
-# Cards
-
-Cards provide a visually distinct block for grouping related content. They are a versatile component that can be used for feature overviews, summaries, or linking to other sections.
-
-## Usage
-
-The `card` container can be used with or without a title.
-
-::: callout info
-Container blocks (like `::: card`) should be preceded by a blank line to ensure proper parsing by the markdown processor.
-:::
-
-**Syntax:**
-```markdown
-::: card Optional Card Title
-The main body content of the card.
-Supports **Markdown** formatting.
-:::
-```
--   `Optional Card Title`: If you provide text after `card`, it becomes the title of the card.
-
----
-
-## Examples
-
-### Card with a Title
-
-This is the most common use case, where the card has a clear heading.
-
-**Code:**
-```markdown
-::: card My Feature Overview
-This card describes an amazing feature.
-* It's easy to use.
-* It solves a common problem.
-
-Learn more by reading the full guide.
-:::
-```
-
-**Rendered Preview:**
-::: card My Feature Overview
-This card describes an amazing feature.
-* It's easy to use.
-* It solves a common problem.
-
-Learn more by reading the full guide.
-:::
-
-### Card without a Title
-
-If you omit the title, the content starts directly. This is ideal for small, self-contained snippets or quotes.
-
-**Code:**
-```markdown
-::: card
-This is a card without an explicit title. The content starts directly, which is great for simple, focused information.
-:::
-```
-
-**Rendered Preview:**
-::: card
-This is a card without an explicit title. The content starts directly, which is great for simple, focused information.
-:::
-
-### Nesting Content in Cards
-
-Cards are great for composition. You can easily place other elements, like buttons, inside a card to create a call to action.
-
-**Code:**
-```markdown
-::: card Download the App
-Get the latest version for your platform and start building today.
-
-::: button Learn_More #customization
-::: button View_GitHub external:https://github.com/mgks/docmd color:#5865f2
-:::
-```
-
-**Rendered Preview:**
-
-::: card Download the App
-Get the latest version for your platform and start building today.
-
-::: button Learn_More #customization
-::: button View_GitHub external:https://github.com/mgks/docmd color:#5865f2
-
-:::

package/docs/content/containers/changelogs.md

@@ -1,128 +0,0 @@
----
-title: "Container: Changelogs"
-description: "Create a beautiful, timeline-style version history for your project."
----
-
-# Changelog Container
-
-The `changelog` container allows you to present version history and release notes in a clean, timeline layout. It separates metadata (dates/versions) from the narrative content, making it easy for users to scan updates.
-
-## Usage
-
-The changelog container uses a specific syntax where entries are separated by `==` markers.
-
-::: callout info
-Container blocks (like `::: changelog`) should be preceded by a blank line.
-:::
-
-**Syntax:**
-```markdown
-::: changelog
-
-== Version/Date String
-Content for this version.
-Supports **Markdown**, lists, and other containers.
-
-== Next Version/Date String
-Content for the next version.
-
-:::
-```
-
-**`==`**: This marker denotes the start of a new entry. Everything after `==` on the same line is treated as the "Date" or "Version" badge on the left side of the timeline.
-
----
-
-## Examples
-
-### Basic Version History
-
-**Code:**
-```markdown
-::: changelog
-
-== v2.0.0 (2025-01-15)
-### Major Update 🚀
-We completely rewrote the core engine for better performance.
-
-*   Added new plugin system
-*   Improved build speed by 50%
-
-== v1.1.0 (2024-12-01)
-### Feature Drop
-Added support for custom themes and dark mode.
-
-== v1.0.0 (2024-11-10)
-Initial public release.
-:::
-```
-
-**Rendered Preview:**
-
-::: changelog
-
-== v2.0.0 (2025-01-15)
-### Major Update 🚀
-We completely rewrote the core engine for better performance.
-
-*   Added new plugin system
-*   Improved build speed by 50%
-
-== v1.1.0 (2024-12-01)
-### Feature Drop
-Added support for custom themes and dark mode.
-
-== v1.0.0 (2024-11-10)
-Initial public release.
-:::
-
-### Changelog with Nested Elements
-
-You can put anything inside a changelog entry, including callouts and code blocks.
-
-**Code:**
-````markdown
-::: changelog
-
-== v3.0.0-beta
-### The Future is Here
-
-::: callout warning Breaking Changes
-This release changes the config format. Please update your `docmd.config.js`.
-:::
-
-**New Config Example:**
-```javascript
-module.exports = {
-  version: 3,
-  // ...
-}
-```
-
-== v2.5.0
-Maintenance release with bug fixes.
-:::
-````
-
-**Rendered Preview:**
-
-::: changelog
-
-== v3.0.0-beta
-### The Future is Here
-
-::: callout warning Breaking Changes
-This release changes the config format. Please update your `docmd.config.js`.
-:::
-
-**New Config Example:**
-```javascript
-module.exports = {
-  version: 3,
-  // ...
-}
-```
-
-== v2.5.0
-Maintenance release with bug fixes.
-:::

package/docs/content/containers/collapsible.md

@@ -1,89 +0,0 @@
----
-title: "Container: Collapsible"
-description: "Create accordion-style toggleable sections for FAQs, spoilers, or advanced details."
----
-
-# Collapsible Container
-
-The `collapsible` container creates an accordion-style block that can be toggled open or closed. This is perfect for FAQs, "spoiler" content, or hiding complex details that aren't immediately necessary.
-
-## Usage
-
-The syntax allows you to define the title and the default state (open or closed).
-
-**Syntax:**
-```markdown
-::: collapsible [open] Title Text Here
-The hidden content goes here.
-:::
-```
-
--   **`open`**: (Optional) If included, the section will be expanded by default on page load.
--   **`Title Text Here`**: The text displayed on the clickable bar. If omitted, it defaults to "Click to expand".
-
----
-
-## Examples
-
-### Basic Collapsible (Closed by Default)
-
-Use this for content that should be hidden initially, like lengthy code examples or optional details.
-
-**Code:**
-```markdown
-::: collapsible View Advanced Configuration
-Here are the advanced settings for power users:
-*   `memory_limit`: Set the max heap size.
-*   `threads`: Number of worker threads.
-:::
-```
-
-**Rendered Preview:**
-
-::: collapsible View Advanced Configuration
-Here are the advanced settings for power users:
-*   `memory_limit`: Set the max heap size.
-*   `threads`: Number of worker threads.
-:::
-
-### Default Open
-
-Use the `open` keyword if you want the content visible but capable of being tucked away.
-
-**Code:**
-```markdown
-::: collapsible open Important Notice
-This content is visible immediately but can be collapsed if it takes up too much space.
-:::
-```
-
-**Rendered Preview:**
-
-::: collapsible open Important Notice
-This content is visible immediately but can be collapsed if it takes up too much space.
-:::
-
-### FAQ Pattern
-
-Collapsibles are ideal for Frequently Asked Questions.
-
-**Code:**
-```markdown
-::: collapsible Is docmd free to use?
-**Yes!** docmd is 100% open-source and free under the MIT license.
-:::
-
-::: collapsible Can I host it on GitHub Pages?
-Absolutely. The `build` command generates static HTML files that work perfectly on GitHub Pages, Netlify, or Vercel.
-:::
-```
-
-**Rendered Preview:**
-
-::: collapsible Is docmd free to use?
-**Yes!** docmd is 100% open-source and free under the MIT license.
-:::
-
-::: collapsible Can I host it on GitHub Pages?
-Absolutely. The `build` command generates static HTML files that work perfectly on GitHub Pages, Netlify, or Vercel.
-:::

package/docs/content/containers/index.md

@@ -1,35 +0,0 @@
----
-title: "Custom Containers"
-description: "Enhance your documentation with special components like callouts, cards, steps, and tabs using docmd's custom container syntax."
----
-
-`docmd` provides a simple syntax for adding richer, pre-styled components to your Markdown content. These are powered by the `markdown-it-container` plugin.
-
-The general syntax for simple containers like `callout` and `card` is:
-
-```markdown
-::: containerName [optionalTitleOrType]
-Content for the container goes here.
-:::
-```
-
-For more complex components like `steps` and `tabs`, we use a more robust and intuitive syntax that relies on standard Markdown, preventing common nesting issues.
-
-## Advanced Nested Container System
-
-With docmd v0.2.0, all containers support **seamless nesting** - you can nest any container within any other container to create complex, interactive documentation layouts.
-
-**New in v0.2.0:** [Learn about nested containers →](./nested-containers)
-
-## Available Containers
-
-Select a container type from the list below or from the sidebar to see detailed usage instructions and examples.
-
-- [**Callouts**](./callouts/) - For highlighting important information like notes, tips, and warnings.
-- [**Cards**](./cards/) - For grouping related content into visually distinct blocks.
-- [**Steps**](./steps/) - For presenting a sequence of instructions in a numbered format.
-- [**Tabs**](./tabs/) - For organizing content in a switchable, tabbed interface.
-- [**Buttons**](./buttons/) - For creating stylish, clickable calls to action.
-- [**Nested Containers**](./nested-containers/) - For creating complex, interactive layouts with container nesting.
-
-These custom containers allow you to create more engaging and structured documentation without needing to write custom HTML or CSS.