diff --git a/README.md b/README.md index 292375db6..e0456ac91 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,21 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h Show/Hide - [🌱 Forgetful Notes](#-forgetful-notes) - - [Table of Contents](#table-of-contents) + - [Contents](#contents) - [Screenshots](#screenshots) - [Full Width](#full-width) - [Slim (light)](#slim-light) - [Slim (dark)](#slim-dark) + - [Features](#features) - [Useful Commands](#useful-commands) - [Customization](#customization) - [Stylesheets](#stylesheets) - [Fonts](#fonts) + - [From Obsidian](#from-obsidian) + - [Background](#background) + - [Technology](#technology) - [Folder Structure](#folder-structure) - - [Acknowledgements and Attributions](#acknowledgements-and-attributions) + - [Attributions](#attributions) - [License](#license) @@ -52,6 +56,15 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h +## Features + +- Fast Natural-Language Search +- Bidirectional Backlinks +- Floating Link Previews +- Admonition-style Callouts +- Markdown Links and Wikilinks Support +- Latex Support + ## Useful Commands ```sh @@ -91,6 +104,22 @@ You can add custom CSS code within `/quartz/styles/custom.scss`. You will then n | Body | [Bitter](https://fonts.google.com/specimen/Bitter) | [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+3) | | Code | [Fira Mono](https://fonts.google.com/specimen/Fira+Mono) | [IBM Plex Mono](https://fonts.google.com/specimen/IBM+Plex+Mono) | +## From Obsidian + +**Forgetful Notes** is created using [Quartz](https://github.com/jackyzha0/quartz), hosted on [GitHub](https://github.com/), deployed with [GitHub Pages](https://pages.github.com/), and facilitated by the GitHub [Publisher](https://github.com/ObsidianPublisher) plugin for [Obsidian](https://obsidian.md/). If interested, you can browse the [source](https://github.com/semanticdata/forgetful-notes) code. + +## Background + +Forgetful Notes has gone through many changes. I have not been shy about moving from technology to technology as I learn new things. Coming across the world of [[Static Site Generators]] was a game changer. I have ran my notes through [Jekyll](https://jekyllrb.com/), [Hugo](https://gohugo.io/), [MkDocs](https://squidfunk.github.io/mkdocs-material/), and most recently [Zola](https://www.getzola.org/). + +However, this site is not specifically built with any of the aforementioned. Instead I have opted to follow in the footsteps of [Jacky Zhao](https://github.com/jackyzha0) and created my [[Digital Garden]] using the new fully rewritten [Quartz](https://github.com/jackyzha0/quartz)—a set of tools that helps you publish your digital garden and notes as a website for free. + +## Technology + +All content for the site is written in [[Markdown]] within [Obsidian](https://obsidian.md/)—an extensible, flexible note-taking app. To export the notes from Obsidian, I rely on the [GitHub Publisher](https://github.com/ObsidianPublisher) plugin. + +The [source code](https://github.com/semanticdata/forgetful-notes) is hosted in [GitHub](https://github.com/). From here we use [GitHub Actions](https://github.com/features/actions) to build and deploy the site to [GitHub Pages](https://pages.github.com/). + ## Folder Structure
@@ -172,7 +201,7 @@ You can add custom CSS code within `/quartz/styles/custom.scss`. You will then n
-## Acknowledgements and Attributions +## Attributions Forgetful Notes is based on [Quartz](https://github.com/jackyzha0/quartz).