diff --git a/content/About.md b/content/About.md index 669d3acbf..ab3e1d97a 100644 --- a/content/About.md +++ b/content/About.md @@ -1,7 +1,7 @@ --- title: About compartir: true -updated: 2023-10-04 +updated: 2023-10-12 tags: [meta] --- ## Hi! I'm Miguel 👋🏼 @@ -18,8 +18,10 @@ If you are aching for more: ### As of October 2023, I am… … tending to my [digital garden](https://forgetfulnotes.com/). +… learning about web dev with [Zola](https://www.getzola.org). … making simple browser [extensions](https://addons.mozilla.org/en-US/firefox/user/17772574/). … collecting bookmarks with [Raindrop](https://raindrop.io/SemanticData). +… compiling [configuration files](https://github.com/semanticdata/dotfiles) in [GitHub](https://github.com/). … developing both a [theme](https://github.com/semanticdata/obsidian-sample-theme), and a [starter vault](https://github.com/semanticdata/obsidian-starter-vault) for [Obsidian](https://obsidian.md/). ### Reaching Out diff --git a/content/Meta.md b/content/Meta.md index e9e209454..623da80e1 100644 --- a/content/Meta.md +++ b/content/Meta.md @@ -2,7 +2,7 @@ title: Meta (how this site was made) description: How the site was made. compartir: true -updated: 2023-10-11 +updated: 2023-10-12 tags: [meta] --- @@ -10,11 +10,11 @@ tags: [meta] > > **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 +### 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 [[./Seedlings/Static Site Generators|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 specifically not 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|Digital Garden]] using the new fully rewritten version of [Quartz](https://github.com/jackyzha0/quartz)—a set of tools that helps you publish your digital garden and notes as a website for free. Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use. +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|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 @@ -49,3 +49,22 @@ root/ └── quartz.layout.ts └── package.json ``` + +```markdown-tree +root + .github + workflows/ + content + About.md + Digital Garden.md + Meta.md + Public Journal.md + docs/ + quartz + components/ + plugins/ + styles/ + quartz.config.ts + quartz.layout.ts + package.json +``` diff --git a/docs/authoring content.md b/docs/authoring content.md deleted file mode 100644 index fa6eea258..000000000 --- a/docs/authoring content.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Authoring Content ---- - -All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initailized. Any Markdown in this folder will get processed by Quartz. - -It is recommended that you use [Obsidian](https://obsidian.md/) as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments. - -Got everything setup? Let's [[build]] and preview your Quartz locally! - -## Syntax - -As Quartz uses Markdown files as the main way of writing content, it fully supports Markdown syntax. By default, Quartz also ships with a few syntax extensions like [Github Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (footnotes, strikethrough, tables, tasklists) and [Obsidian Flavored Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown) ([[callouts]], [[wikilinks]]). - -Additionally, Quartz also allows you to specify additional metadata in your notes called **frontmatter**. - -```md title="content/note.md" ---- -title: Example Title -draft: false -tags: - - example-tag ---- - -The rest of your content lives here. You can use **Markdown** here :) -``` - -Some common frontmatter fields that are natively supported by Quartz: - -- `title`: Title of the page. If it isn't provided, Quartz will use the name of the file as the title. -- `aliases`: Other names for this note. This is a list of strings. -- `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz. -- `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format. - -## Syncing your Content - -When your Quartz is at a point you're happy with, you can save your changes to GitHub by doing `npx quartz sync`. - -> [!hint] Flags and options -> For full help options, you can run `npx quartz sync --help`. -> -> Most of these have sensible defaults but you can override them if you have a custom setup: -> -> - `-d` or `--directory`: the content folder. This is normally just `content` -> - `-v` or `--verbose`: print out extra logging information -> - `--commit` or `--no-commit`: whether to make a `git` commit for your changes -> - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz -> - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing diff --git a/docs/features/table of contents.md b/docs/features/table of contents.md deleted file mode 100644 index a66c85017..000000000 --- a/docs/features/table of contents.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Table of Contents" -tags: - - component - - plugin/transformer ---- - -Quartz can automatically generate a table of contents from a list of headings on each page. It will also show you your current scroll position on the site by marking headings you've scrolled through with a different colour. - -By default, it will show all headers from H1 (`# Title`) all the way to H3 (`### Title`) and will only show the table of contents if there is more than 1 header on the page. -You can also hide the table of contents on a page by adding `showToc: false` to the frontmatter for that page. - -> [!info] -> This feature requires both `Plugin.TableOfContents` in your `quartz.config.ts` and `Component.TableOfContents` in your `quartz.layout.ts` to function correctly. - -## Customization - -- Removing table of contents: remove all instances of `Plugin.TableOfContents()` from `quartz.config.ts`. and `Component.TableOfContents()` from `quartz.layout.ts` -- Changing the max depth: pass in a parameter to `Plugin.TableOfContents({ maxDepth: 4 })` -- Changing the minimum number of entries in the Table of Contents before it renders: pass in a parameter to `Plugin.TableOfContents({ minEntries: 3 })` -- Component: `quartz/components/TableOfContents.tsx` -- Style: - - Modern (default): `quartz/components/styles/toc.scss` - - Legacy Quartz 3 style: `quartz/components/styles/legacyToc.scss` -- Script: `quartz/components/scripts/toc.inline.ts`