https://github.com/cuigh/obelisk

A markdown document publishing tool
https://github.com/cuigh/obelisk

markdown obelisk obsidian

Last synced: 20 days ago
JSON representation

A markdown document publishing tool

• Host: GitHub
• URL: https://github.com/cuigh/obelisk
• Owner: cuigh
• Created: 2022-03-23T09:55:43.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-10T04:28:42.000Z (over 2 years ago)
• Last Synced: 2024-11-08T06:41:37.980Z (about 1 month ago)
• Topics: markdown, obelisk, obsidian
• Language: CSS
• Homepage:
• Size: 3.09 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - cuigh/obelisk - A markdown document publishing tool (CSS)

README

        
[English](https://github.com/cuigh/obelisk) | [中文](https://github.com/cuigh/obelisk/blob/master/README_zh.md)

Obelisk is a publishing tool for markdown document library, which can help you generate HTML documents simply and quickly. In particular, out of personal preference, Obelisk has made a lot of optimization for the [Obsidian](https://obsidian.md) document library, and can be used as an alternative to the official publishing service.

## Features

- Compatible with CommonMark, GFM Extensions etc

- Support custom themes

- Support document search

- Support back links

- Support some mainstream plugins of the Obsidian community

	- Excalidraw

	- Banner

	- Kanban

	- Icon Folder

	- ……

## Getting Started

Please follow the [Documentation](https://cuigh.com/obelisk). As you might expect, the document site is also generated with Obelisk.

## Screenshots

**Document**

![Document](docs/assets/document.png)

**Graph**

![Graph](docs/assets/graph.png)

**Extensions**

![Extensions](docs/assets/extension.png)

## Roadmap

- [x] CommonMark

- [x] GFM Extensions

- [x] Callout

- [x] LaTeX

- [x] Comment

- [x] Embed

	- [x] Image

	- [x] Audio

	- [x] Video

	- [x] Excalidraw

	- [x] PDF

	- [x] Markdown

- [x] Plugin

	- [x] Banner

	- [x] Excalidraw

	- [x] Admonition

	- [x] Icon Folder

	- [x] Kanban

	- [x] Charts

	- [x] Timeline

- [x] Theme

- [x] Search

- [x] Graph

- [x] Back links

- [x] Tag links