Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.47 KB

README.md

File metadata and controls

34 lines (28 loc) · 1.47 KB

Obsidian-11ty

Demo site.

This project has created as a platform for publishing selected posts/notes of your Obsidian vault using the front-meter data. It uses the beautiful Eleventy, as static site generator platform.

The main features that makes the Obsidian so cool and implemented here, are:

  • Turn Wikilinks [[links]] as well as MDLinks [links](links.md) into HTML links
  • Images display with custom width
  • Mermaid.js charts
  • Backlinks
  • Search option and etc.

Project Description

Using this repository you will be able to:

  1. (optional) Easily start using Obsidian with my pre-configured Obsidian's vault.
  2. Backup your Obsidian vault using Github as private repository.
  3. Define the publishing rules of your Obsidian vault
  4. CI/CD your publishing vault(or the public part of it) using Netlify/Github.io
  5. Custom build and deploy your blog (or the public part of it) using Docker container as your web server.

Note: Actually this repository is ready to use but there is some remain work needed, aspecially in the documentation area. UnderConstruction

Designed by pikisuperstar / Freepik

Table of Contents

How to Install and Run the Project

Obsidian
Docker
Netlify

How to Use the Project

Credits