From 31c835c4657207e6eafa9e4e5d47c85de383adaa Mon Sep 17 00:00:00 2001 From: semanticdata Date: Tue, 30 Jan 2024 14:05:28 -0600 Subject: [PATCH] add folder structure --- README.md | 122 +++++++++++++++++++++++++++++++++++++++++------ quartz.layout.ts | 2 +- 2 files changed, 109 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index fdef619d0..5abed167d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ## Overview -This is the source code for [Forgetful Notes](https://forgetfulnotes.com)—my digital garden of knowledge. It serves as a platform for my learning and creative endeavours. A space for thinking through, building upon, and coming back to. +This repository holds the source code for [Forgetful Notes](https://forgetfulnotes.com)—my digital garden of knowledge. It serves as a platform for my learning and creative endeavours. A space for thinking through, building upon, and coming back to. It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](https://obsidian.md). You can read the [Documentation](https://quartz.jzhao.xyz/), and join the [Discord Community](https://discord.gg/cRFFHYye7t). @@ -27,19 +27,26 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h - [Slim (dark)](#slim-dark) - [Useful Commands](#useful-commands) - [Install Dependencies](#install-dependencies) + - [Update Dependencies](#update-dependencies) - [Start Local Server](#start-local-server) - [Update Quartz](#update-quartz) - [Sync the Repo](#sync-the-repo) - [Build Only](#build-only) - [Find Help](#find-help) -- [Style](#style) +- [Customization](#customization) + - [Stylesheets](#stylesheets) - [Fonts](#fonts) +- [Folder Structure](#folder-structure) +- [Acknowledgements and Attributions](#acknowledgements-and-attributions) - [License](#license) ## Screenshots +
+Show/Hide + ### Full Width Website Screenshot @@ -52,17 +59,9 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h Website Screenshot -## Useful Commands +
-| Description | Command | -| -------------------- | -------------------------- | -| Install Dependencies | `npm i` | -| Update Dependencies | `npm update` | -| Update Quartz (core) | `npx quartz update` | -| Build only | `npx quartz build` | -| Build and Serve | `npx quartz build --serve` | -| Sync Local Changes | `npx quartz sync` | -| Find Help | `npx quartz sync --help` | +## Useful Commands ### Install Dependencies @@ -71,6 +70,12 @@ npm i npm install ``` +### Update Dependencies + +```bash +npm update +``` + ### Start Local Server ```bash @@ -107,7 +112,11 @@ npx quartz --help npx quartz --help ``` -## Style +## Customization + +### Stylesheets + +You can add custom CSS code within `/quartz/styles/custom.scss`. You will then need to uncomment line 4 of `/quartz/styles/base.scss` to have it take effect. ### Fonts @@ -117,6 +126,91 @@ npx quartz --help | 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) | +## Folder Structure + +
+Show/Hide + +```md +. +├── .github/ +│ └── workflows/ +│ ├── build.yml +│ └── deploy.yml +├── content/ +│ ├── notes.md +│ ├── pages.md +│ └── ... +├── docs/ +│ ├── documentation.md +│ └── ... +├── quartz/ +│ ├── cli/ +│ │ ├── args.js +│ │ ├── constants.js +│ │ ├── handlers.js +│ │ └── helpers.js +│ ├── components/ +│ │ ├── pages/ +│ │ ├── scripts/ +│ │ ├── styles/ +│ │ ├── Backlinks.tsx +│ │ ├── Explorer.tsx +│ │ └── ... +│ ├── plugins/ +│ │ ├── emitters/ +│ │ ├── filters/ +│ │ ├── transformers/ +│ │ ├── index.ts +│ │ ├── types.ts +│ │ └── vfile.ts +│ ├── processors/ +│ │ ├── emit.ts +│ │ ├── filter.ts +│ │ └── parse.ts +│ ├── static/ +│ │ ├── favicon.ico +│ │ ├── site.manifest +│ │ └── ... +│ ├── styles/ +│ │ ├── base.scss +│ │ ├── callouts.scss +│ │ ├── custom.scss +│ │ ├── syntax.scss +│ │ └── variables.scss +│ ├── util/ +│ │ ├── theme.ts +│ │ ├── jsx.tsx +│ │ └── ... +│ ├── bootstrp.cli.mjs +│ ├── bootstrap-worker.njs +│ ├── build.ts +│ ├── cfg.ts +│ └── worker.ts +├── .gitattributes +├── .gitignore +├── .npmrc +├── .prettierignore +├── .prettierrc +├── Dockerfile +├── LICENSE +├── README.md +├── globals.d.ts +├── index.d.ts +├── package-lock.json +├── package.json +├── quartz.config.ts +├── quartz.layout.ts +├── screenshot.png +└── tsconfig.json +``` + +
+ +## Acknowledgements and Attributions + +Forgetful Notes is based on [Quartz](https://github.com/jackyzha0/quartz). + ## License -Source code in this repository is available under the [MIT](LICENSE) license. You are free to use this code however you see fit. That said, some acknowledgement would be well received. +Source code in this repository is available under the [MIT License](LICENSE). diff --git a/quartz.layout.ts b/quartz.layout.ts index 4bbe1b782..ebe3c6d95 100644 --- a/quartz.layout.ts +++ b/quartz.layout.ts @@ -25,7 +25,7 @@ export const defaultContentPageLayout: PageLayout = { Component.ContentMeta(), // Component.TagList(), Component.MobileOnly(Component.TableOfContents()), - // Component.MobileOnly(Component.Spacer()), + Component.MobileOnly(Component.Spacer()), ], left: [ Component.PageTitle(),