mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-24 23:15:46 -05:00
add folder structure
This commit is contained in:
parent
6e13d50d48
commit
31c835c465
122
README.md
122
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)
|
||||
|
||||
</details>
|
||||
|
||||
## Screenshots
|
||||
|
||||
<details>
|
||||
<summary>Show/Hide</summary>
|
||||
|
||||
### Full Width
|
||||
|
||||
<img alt="Website Screenshot" src="screenshot-full.png" width="720px" />
|
||||
@ -52,17 +59,9 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h
|
||||
|
||||
<img alt="Website Screenshot" src="screenshot-dark.png" width="360px" />
|
||||
|
||||
## Useful Commands
|
||||
</details>
|
||||
|
||||
| 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 <command> --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 <command> --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
|
||||
|
||||
<details>
|
||||
<summary>Show/Hide</summary>
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## 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).
|
||||
|
||||
@ -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(),
|
||||
|
||||
Loading…
Reference in New Issue
Block a user