Git Product home page Git Product logo

ecarrara / obsidian-garden Goto Github PK

View Code? Open in Web Editor NEW
95.0 3.0 4.0 58 KB

Transform Obsidian Vault's notes into web pages. Converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment.

License: MIT License

Rust 54.61% HTML 13.53% JavaScript 15.21% CSS 14.04% Shell 2.61%
digital-garden markdown-notes obsidian obsidian-publish static-site-generator hacktoberfest

obsidian-garden's Introduction

Obsidian Garden

Obsidian Garden is a program to transform Obsidian Vault's notes into web pages. It converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment.

Installation

If you are on OS X or Linux, you can use the installation script to fetch the latest release:

curl https://raw.githubusercontent.com/ecarrara/obsidian-garden/main/install.sh | sh

Features

  • Generate fully static HTML files - SEO friendly and easy to deploy
  • Full-text search with pagefind
  • Math expressions with KaTeX
  • Table of contents
  • Excalidraw support

Getting Started

  1. Navigate to you Vault folder and run obsidian-garden init
cd my-notes/
obsidian-garden init
  1. Customize your site settings by editing the .garden/site.yaml file
title: Site name
pagefind: false
topnav:
  links:
    - text: Link 1
      href: https://example.com/link-1
    - text: Link 2
      href: https://example.com/link-2
  1. Generate a static site from your notes.
obsidian-garden build
  1. Optional - Enable pagefind on .garden/site.yaml and run pagefind to index your site
pagefind --source dist

obsidian-garden's People

Contributors

ecarrara avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

obsidian-garden's Issues

Add support to math expressions (LaTex/MathJax support)

Is your feature request related to a problem? Please describe.
I use Obsidian to take note in class and then publish it online.

In my Database Course, there are many mathematical expressions in the subjects.
At first, we tried using regular characters to show math formulas, but that approach had some big limitations and was quite challenging to work with during classes, copying symbols from the internet. Like Ȼ e 3√y.

As the next step, we started using Quick LaTeX Obsidian to write mathematical expressions, and it's been a very good solution! However, we encountered difficulties converting LaTeX expressions to Markdown and publishing them accurately..

Describe the solution you'd like
Add support to math syntax like Obsidian does.

Using double dollar signs:

$$
\begin{vmatrix}a & b\\
c & d
\end{vmatrix}=ad-bc
$$

And inline math expression using single dollar, like $e^{2i\pi} = 1$.

Additional context
A online example here.

Probably shouldn't default to /usr/local/bin for install location

Is your feature request related to a problem? Please describe.
Looking through the install script, it currently tries to install with /usr/local/bin.
Describe the solution you'd like
~/.local/bin should be defaulted to instead; it follows the XDG Base Directory Specification and it doesn't require administrator priviledges.

Additional context
If a systemwide installation is desired(the user does something like run with sudo or passes a commandline flag), I'd opt for something under opt/ rather in /usr/local/bin, as stuff under /usr is generally reserved for system installed packages with fedora/redhat and sundry

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.