https://github.com/nottimtam/extrusive.md

A competitive, open-source tool for building self-hosted documentation websites.
https://github.com/nottimtam/extrusive.md

cli documentation documentation-generator express javascript markdown

Last synced: 2 days ago
JSON representation

A competitive, open-source tool for building self-hosted documentation websites.

• Host: GitHub
• URL: https://github.com/nottimtam/extrusive.md
• Owner: NotTimTam
• License: cc0-1.0
• Created: 2023-05-02T20:46:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-01T22:28:56.000Z (over 1 year ago)
• Last Synced: 2024-09-25T21:01:08.651Z (2 days ago)
• Topics: cli, documentation, documentation-generator, express, javascript, markdown
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/extrusive.md
• Size: 671 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Example of an extrusive app.](./example.png)

# extrusive.md

[![NPM](https://github.com/NotTimTam/extrusive.md/actions/workflows/npm-publish.yml/badge.svg?branch=main)](https://github.com/NotTimTam/extrusive.md/actions/workflows/npm-publish.yml)

[Obsidian](https://obsidian.md/) is an **"extrusive”** rock, which means it is made from magma that erupted out of a volcano.




^ Wonderful markdown editor!

---

#### `extrusive.md` is now stable! Install version `^1.2.3` today!

There are a lot of markdown interfaces out there. There are a lot of documentation tools out there.

`extrusive.md` fills the niche that none of these do.

1. **100% free and open-source** now, and forever!

2. Hands you control and can be compiled as a **static website**, or an **express server**!

3. Designed with a **simple interface** that requires almost no set-up work.

4. Allows easy implementation of **custom styles** in your documentation.

5. **Builds lightning-fast** using your folder structure and `.md` files. Meaning you can edit your docs in whatever environment you want.

6. Includes a **built-in search bar**, that works... That you don't have to pay for!

7. Has a simple toggle for **light/dark mode**.

8. Built with a **mobile-first design** model and styled with **inspiration from other modern documentation websites**.

9. O.O.T.B. support for **[ion-icons](https://ionic.io/ionicons) + custom HTML** directly in your markdown!

10. Built-in print/save as pdf support.

`extrusive.md` may not have all the bells and whistles, but it makes up for these by being open-ended and ready for you to customize!

## Installation

[Read the docs!](https://nottimtam.github.io/extrusive-docs/)

## Development Roadmap

Client:

-   Emoji support. (`[marked-emoji](https://www.npmjs.com/package/marked-emoji)`)

-   Admonition support. (`[marked-admonition-extension](https://www.npmjs.com/package/marked-admonition-extension)`)

-   Cleaner, more reliable client-side code.

-   Automatical removal of search results that link to paths that no longer exist.

-   Folder/file level of importance for sorting.

-   Search should use all unique words in query and compare against all unique words in document.

-   Fix `` element styles on light mode within search modal.

CLI:

-   **"start"** command with live server for development that does not rely on a build.

-   Sanitize output html.

-   Fix build command only sometimes needing the `--force` option to overwrite. (usually when not using the default "build" folder label)

General:

-   Explore the potential for headless CMS.