update documentation, improve color/font organization
This commit is contained in:
Ben Cuan
parent
6968375d8b
commit
02e83fd14b
2
.github/FUNDING.yml
vendored
2
.github/FUNDING.yml
vendored
@ -1 +1 @@
|
||||
github: [jackyzha0]
|
||||
github: [64bitpandas]
|
||||
|
||||
97
README.md
97
README.md
@ -1,6 +1,6 @@
|
||||
# Amethyst Hugo Theme
|
||||
|
||||
[](https://gohugo.io)
|
||||
[](https://gohugo.io)
|
||||
[](LICENSE)
|
||||
|
||||
Amethyst combines the navigational features of [hugo-book](https://github.com/alex-shpak/hugo-book) with the Obsidian integrations of [quartz](https://github.com/jackyzha0/quartz) to provide a hassle-free place to store and host personal notes or documentation.
|
||||
@ -18,6 +18,11 @@ Insert screenshot here
|
||||
- Interactive graph view
|
||||
- Tab cards for practice problems
|
||||
|
||||
## Documentation
|
||||
If you just want to use Amethyst for your own notes hosting, go to [amethyst.bencuan.me](https://amethyst.bencuan.me) for a demo and documentation on how to use it.
|
||||
|
||||
Keep reading if you want to help develop Amethyst, or make changes to the code base for your own needs.
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Go 1.16 or higher**: [installation instructions](https://golang.org/doc/install)
|
||||
@ -26,59 +31,11 @@ Insert screenshot here
|
||||
- **Hugo-obsidian:** Run `go install github.com/jackyzha0/hugo-obsidian@latest`.
|
||||
- If you're getting a `command not found` error, [ensure that your PATH is configured properly so that binaries in the GOPATH can be executed](https://stackoverflow.com/questions/21001387/how-do-i-set-the-gopath-environment-variable-on-ubuntu-what-file-must-i-edit).
|
||||
|
||||
## Installation
|
||||
## Live Server
|
||||
|
||||
### Install as git submodule
|
||||
Navigate to your hugo project root and run:
|
||||
Start the live server using `make serve`. Content will be served to `localhost:1313` by default.
|
||||
|
||||
```
|
||||
git submodule add https://github.com/64bitpandas/amethyst themes/amethyst
|
||||
```
|
||||
|
||||
Then run hugo (or set `theme = "amethyst"`/`theme: amethyst` in configuration file)
|
||||
|
||||
```
|
||||
hugo server --minify --theme amethyst
|
||||
```
|
||||
|
||||
### Install as hugo module
|
||||
|
||||
You can also add this theme as a Hugo module instead of a git submodule.
|
||||
|
||||
Start with initializing hugo modules, if not done yet:
|
||||
```
|
||||
hugo mod init github.com/repo/path
|
||||
```
|
||||
|
||||
Navigate to your hugo project root and add [module] section to your `config.toml`:
|
||||
|
||||
```toml
|
||||
[module]
|
||||
[[module.imports]]
|
||||
path = 'github.com/alex-shpak/hugo-book'
|
||||
```
|
||||
|
||||
Then, to load/update the theme module and run hugo:
|
||||
|
||||
```sh
|
||||
hugo mod get -u
|
||||
hugo server --minify
|
||||
```
|
||||
|
||||
### Creating site from scratch
|
||||
|
||||
Below is an example on how to create a new site from scratch:
|
||||
|
||||
```sh
|
||||
hugo new site mydocs; cd mydocs
|
||||
git init
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book
|
||||
cp -R themes/hugo-book/exampleSite/content .
|
||||
```
|
||||
|
||||
```sh
|
||||
hugo server --minify --theme hugo-book
|
||||
```
|
||||
The server will need to be restarted to preview changes to navigation (internal links and sidebar menu).
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -152,6 +109,7 @@ In addition to this, there are several empty partials you can override to easily
|
||||
| `assets/_custom.scss` | Customise or override scss styles |
|
||||
| `assets/_variables.scss` | Override default SCSS variables |
|
||||
| `assets/_fonts.scss` | Replace default font with custom fonts (e.g. local files or remote like google fonts) |
|
||||
| `assets/_colors.scss` | Change the default color schemes |
|
||||
| `assets/mermaid.json` | Replace Mermaid initialization config |
|
||||
|
||||
### Plugins
|
||||
@ -178,41 +136,18 @@ In fact almost empty not quite empty because an empty file looks like absent for
|
||||
<!-- -->
|
||||
```
|
||||
|
||||
## Shortcodes
|
||||
|
||||
- [Buttons](https://hugo-book-demo.netlify.app/docs/shortcodes/buttons/)
|
||||
- [Columns](https://hugo-book-demo.netlify.app/docs/shortcodes/columns/)
|
||||
- [Details](https://hugo-book-demo.netlify.app/docs/shortcodes/details/)
|
||||
- [Hints](https://hugo-book-demo.netlify.app/docs/shortcodes/hints/)
|
||||
- [KaTeX](https://hugo-book-demo.netlify.app/docs/shortcodes/katex/)
|
||||
- [Mermaid](https://hugo-book-demo.netlify.app/docs/shortcodes/mermaid/)
|
||||
- [Tabs](https://hugo-book-demo.netlify.app/docs/shortcodes/tabs/)
|
||||
|
||||
By default, Goldmark trims unsafe outputs which might prevent some shortcodes from rendering. It is recommended to set `markup.goldmark.renderer.unsafe=true` if you encounter problems.
|
||||
|
||||
```toml
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
```
|
||||
|
||||
If you are using `config.yaml` or `config.json`, consult the [configuration markup](https://gohugo.io/getting-started/configuration-markup/)
|
||||
|
||||
## Versioning
|
||||
|
||||
This theme follows a simple incremental versioning. e.g. `v1`, `v2` and so on. There might be breaking changes between versions.
|
||||
|
||||
If you want lower maintenance, use one of the released versions. If you want to live on the bleeding edge of changes, you can use the `master` branch and update your website when needed.
|
||||
If you want lower maintenance, use one of the released versions. If you want to live on the bleeding edge of changes, you can use the `main` branch and update your website when needed.
|
||||
|
||||
## Contributing
|
||||
|
||||
### [Extra credits to contributors](https://github.com/alex-shpak/hugo-book/graphs/contributors)
|
||||
Contributions are welcome! Please make an issue or pull request if there are any changes you'd like to see.
|
||||
|
||||
Contributions are welcome and I will review and consider pull requests.
|
||||
Primary goals are:
|
||||
## Credits
|
||||
|
||||
- Keep it simple.
|
||||
- Keep minimal (or zero) default configuration.
|
||||
- Avoid interference with user-defined layouts.
|
||||
- Avoid using JS if it can be solved by CSS.
|
||||
|
||||
Feel free to open issues if you find missing configuration or customisation options.
|
||||
A large portion of Amethyst's code base can be derived from the following two projects. Original attribution goes to the creators of these projects; I just put them together, squashed all the bugs, and customized the styles to fit my needs for Amethyst.
|
||||
- [Hugo Book](https://github.com/alex-shpak/hugo-book)
|
||||
- [Quartz](https://github.com/jackyzha0/quartz)
|
||||
|
||||
28
assets/_colors.scss
Normal file
28
assets/_colors.scss
Normal file
@ -0,0 +1,28 @@
|
||||
:root {
|
||||
--light: #faf8f8;
|
||||
--dark: #141021;
|
||||
--secondary: #7c00ce;
|
||||
--tertiary: #ff48d4;
|
||||
--visited: #afbfc9;
|
||||
--primary: #f28482;
|
||||
--gray: #3f3f3f;
|
||||
--lightgray: #f0f0f0;
|
||||
--outlinegray: #dadada;
|
||||
--million-progress-bar-color: var(--secondary);
|
||||
--highlighted: #8446ff88;
|
||||
--header: #bca1ff;
|
||||
}
|
||||
|
||||
[saved-theme="dark"] {
|
||||
--light: #1e1e21 !important;
|
||||
--dark: #f7f2fa !important;
|
||||
--secondary: #b866ff !important;
|
||||
--visited: #d199ff !important;
|
||||
--tertiary: #92a8ff !important;
|
||||
--primary: #f58382 !important;
|
||||
--gray: #d4d4d4 !important;
|
||||
--lightgray: #292633 !important;
|
||||
--outlinegray: #343434 !important;
|
||||
--highlighted: #574010;
|
||||
--header: #7838f8;
|
||||
}
|
||||
@ -1,3 +1,12 @@
|
||||
// Replace this with your own font imports!
|
||||
@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&family=Source+Sans+Pro:wght@400;600&display=swap');
|
||||
|
||||
:root {
|
||||
--font-body: "PP Mori", "Source Sans Pro", sans-serif;
|
||||
--font-header: "PP Mori", "Source Sans Pro", sans-serif;
|
||||
--font-mono: "PP Fraktion Mono", "Fira Code", monospace;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: "PP Mori";
|
||||
font-style: normal;
|
||||
@ -53,7 +62,7 @@
|
||||
font-family: "PP Fraktion Mono";
|
||||
font-style: normal;
|
||||
font-weight: lighter;
|
||||
src: url('fonts/PPFraktionMono-Light.woff2');
|
||||
src: url('fonts/PPFraktionMono-Bold.woff2');
|
||||
}
|
||||
|
||||
@font-face {
|
||||
|
||||
@ -12,5 +12,6 @@
|
||||
@import "shortcodes";
|
||||
|
||||
// Custom defined styles
|
||||
@import "colors";
|
||||
@import "amethyst";
|
||||
@import "custom";
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -58,152 +58,6 @@
|
||||
"text": "notes/foo/footest"
|
||||
}
|
||||
],
|
||||
"/configuration/config": [
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
}
|
||||
],
|
||||
"/configuration/docker": [
|
||||
{
|
||||
"source": "/configuration/docker",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "install Quartz's dependencies manually"
|
||||
}
|
||||
],
|
||||
"/configuration/editing": [
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/configuration/hosting": [
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/custom-Domain",
|
||||
"text": "Learn how to set it up with Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/docker",
|
||||
"text": "Docker"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/config",
|
||||
"text": "Customizing Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/configuration/obsidian": [
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/setup",
|
||||
"text": "setup"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
}
|
||||
],
|
||||
"/configuration/preview-changes": [
|
||||
{
|
||||
"source": "/configuration/preview-changes",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
}
|
||||
],
|
||||
"/configuration/setup": [
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/editing",
|
||||
"text": "Editing Notes in Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/configuration/troubleshooting": [
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "Obsidian"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "the hosting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/config",
|
||||
"text": "customization guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "local editing"
|
||||
}
|
||||
],
|
||||
"/cs61b/": [
|
||||
{
|
||||
"source": "/cs61b/",
|
||||
@ -848,9 +702,143 @@
|
||||
"/features/languages": [
|
||||
{
|
||||
"source": "/features/languages",
|
||||
"target": "/notes/config",
|
||||
"target": "/setup/config",
|
||||
"text": "config"
|
||||
}
|
||||
],
|
||||
"/setup/config": [
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/features/language",
|
||||
"text": "Chinese, Japanese, and Korean support"
|
||||
},
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/setup/editing": [
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/setup/hosting": [
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/custom-Domain",
|
||||
"text": "Learn how to set it up with Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/config",
|
||||
"text": "Customizing Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/setup/obsidian": [
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/setup",
|
||||
"text": "setup"
|
||||
},
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
}
|
||||
],
|
||||
"/setup/preview-changes": [
|
||||
{
|
||||
"source": "/setup/preview-changes",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
}
|
||||
],
|
||||
"/setup/setup": [
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/editing",
|
||||
"text": "Editing Notes in Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/setup/troubleshooting": [
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/features/latex",
|
||||
"text": "LaTeX"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "Obsidian"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "the hosting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/config",
|
||||
"text": "customization guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "local editing"
|
||||
}
|
||||
]
|
||||
},
|
||||
"backlinks": {
|
||||
@ -1457,6 +1445,20 @@
|
||||
"text": "Dynamic Method Selection"
|
||||
}
|
||||
],
|
||||
"/features/language": [
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/features/language",
|
||||
"text": "Chinese, Japanese, and Korean support"
|
||||
}
|
||||
],
|
||||
"/features/latex": [
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/features/latex",
|
||||
"text": "LaTeX"
|
||||
}
|
||||
],
|
||||
"/generics": [
|
||||
{
|
||||
"source": "/cs61b/oop/inheritance",
|
||||
@ -1519,16 +1521,6 @@
|
||||
"source": "/",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
}
|
||||
],
|
||||
"/notes/callouts": [
|
||||
@ -1538,54 +1530,6 @@
|
||||
"text": "Admonition-style callouts"
|
||||
}
|
||||
],
|
||||
"/notes/config": [
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/config",
|
||||
"text": "Customizing Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/config",
|
||||
"text": "customization guide"
|
||||
},
|
||||
{
|
||||
"source": "/features/languages",
|
||||
"target": "/notes/config",
|
||||
"text": "config"
|
||||
}
|
||||
],
|
||||
"/notes/custom-Domain": [
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/custom-Domain",
|
||||
"text": "Learn how to set it up with Quartz"
|
||||
}
|
||||
],
|
||||
"/notes/docker": [
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/docker",
|
||||
"text": "Docker"
|
||||
}
|
||||
],
|
||||
"/notes/editing": [
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/editing",
|
||||
"text": "Editing Notes in Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "local editing"
|
||||
}
|
||||
],
|
||||
"/notes/foo": [
|
||||
{
|
||||
"source": "/",
|
||||
@ -1600,57 +1544,6 @@
|
||||
"text": "notes/foo/footest"
|
||||
}
|
||||
],
|
||||
"/notes/hosting": [
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/preview-changes",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "the hosting guide"
|
||||
}
|
||||
],
|
||||
"/notes/ignore-notes": [
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
}
|
||||
],
|
||||
"/notes/obsidian": [
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "Obsidian"
|
||||
}
|
||||
],
|
||||
"/notes/philosophy": [
|
||||
{
|
||||
"source": "/",
|
||||
@ -1658,23 +1551,6 @@
|
||||
"text": "why I made Quartz"
|
||||
}
|
||||
],
|
||||
"/notes/preview-changes": [
|
||||
{
|
||||
"source": "/configuration/docker",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "install Quartz's dependencies manually"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
}
|
||||
],
|
||||
"/notes/search": [
|
||||
{
|
||||
"source": "/",
|
||||
@ -1687,11 +1563,6 @@
|
||||
"source": "/",
|
||||
"target": "/notes/setup",
|
||||
"text": "Setup your own digital garden using Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/setup",
|
||||
"text": "setup"
|
||||
}
|
||||
],
|
||||
"/notes/showcase": [
|
||||
@ -1706,26 +1577,6 @@
|
||||
"source": "/",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "Troubleshooting and FAQ"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/notes/updating": [
|
||||
@ -1799,6 +1650,139 @@
|
||||
"text": "Sets"
|
||||
}
|
||||
],
|
||||
"/setup/config": [
|
||||
{
|
||||
"source": "/features/languages",
|
||||
"target": "/setup/config",
|
||||
"text": "config"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/config",
|
||||
"text": "Customizing Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/config",
|
||||
"text": "customization guide"
|
||||
}
|
||||
],
|
||||
"/setup/custom-Domain": [
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/custom-Domain",
|
||||
"text": "Learn how to set it up with Amethyst"
|
||||
}
|
||||
],
|
||||
"/setup/editing": [
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/editing",
|
||||
"text": "Editing Notes in Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "local editing"
|
||||
}
|
||||
],
|
||||
"/setup/hosting": [
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
},
|
||||
{
|
||||
"source": "/setup/preview-changes",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "the hosting guide"
|
||||
}
|
||||
],
|
||||
"/setup/ignore-notes": [
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
}
|
||||
],
|
||||
"/setup/obsidian": [
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "Obsidian"
|
||||
}
|
||||
],
|
||||
"/setup/preview-changes": [
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
},
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
}
|
||||
],
|
||||
"/setup/setup": [
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/setup",
|
||||
"text": "setup"
|
||||
}
|
||||
],
|
||||
"/setup/troubleshooting": [
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
}
|
||||
],
|
||||
"/sorting/sorting-basics": [
|
||||
{
|
||||
"source": "/cs61b/SUMMARY",
|
||||
@ -1895,136 +1879,6 @@
|
||||
"target": "/notes/foo/footest",
|
||||
"text": "notes/foo/footest"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/config",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/docker",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "install Quartz's dependencies manually"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/editing",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/custom-Domain",
|
||||
"text": "Learn how to set it up with Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/docker",
|
||||
"text": "Docker"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/config",
|
||||
"text": "Customizing Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/hosting",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/setup",
|
||||
"text": "setup"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/obsidian",
|
||||
"target": "/notes/preview-changes",
|
||||
"text": "Preview Quartz Changes"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/preview-changes",
|
||||
"target": "/notes/hosting",
|
||||
"text": "Hosting Quartz online!"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/editing",
|
||||
"text": "Editing Notes in Quartz"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/setup",
|
||||
"target": "/notes/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95",
|
||||
"text": "CJK + Latex Support (测试)"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/obsidian",
|
||||
"text": "Obsidian"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/hosting",
|
||||
"text": "the hosting guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/config",
|
||||
"text": "customization guide"
|
||||
},
|
||||
{
|
||||
"source": "/configuration/troubleshooting",
|
||||
"target": "/notes/editing",
|
||||
"text": "local editing"
|
||||
},
|
||||
{
|
||||
"source": "/cs61b/SUMMARY",
|
||||
"target": "/CS61B-Index",
|
||||
@ -2612,8 +2466,128 @@
|
||||
},
|
||||
{
|
||||
"source": "/features/languages",
|
||||
"target": "/notes/config",
|
||||
"target": "/setup/config",
|
||||
"text": "config"
|
||||
},
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/features/language",
|
||||
"text": "Chinese, Japanese, and Korean support"
|
||||
},
|
||||
{
|
||||
"source": "/setup/config",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "How to setup your Obsidian Vault to work with Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
},
|
||||
{
|
||||
"source": "/setup/editing",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/custom-Domain",
|
||||
"text": "Learn how to set it up with Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "Excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/config",
|
||||
"text": "Customizing Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/hosting",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/setup",
|
||||
"text": "setup"
|
||||
},
|
||||
{
|
||||
"source": "/setup/obsidian",
|
||||
"target": "/setup/preview-changes",
|
||||
"text": "Preview Changes"
|
||||
},
|
||||
{
|
||||
"source": "/setup/preview-changes",
|
||||
"target": "/setup/hosting",
|
||||
"text": "Hosting Amethyst online!"
|
||||
},
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/editing",
|
||||
"text": "Editing Notes in Amethyst"
|
||||
},
|
||||
{
|
||||
"source": "/setup/setup",
|
||||
"target": "/setup/troubleshooting",
|
||||
"text": "FAQ and Troubleshooting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/features/latex",
|
||||
"text": "LaTeX"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/ignore-notes",
|
||||
"text": "excluding pages from being published"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "hosting"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/obsidian",
|
||||
"text": "Obsidian"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "the 'how to edit' guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/hosting",
|
||||
"text": "the hosting guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/config",
|
||||
"text": "customization guide"
|
||||
},
|
||||
{
|
||||
"source": "/setup/troubleshooting",
|
||||
"target": "/setup/editing",
|
||||
"text": "local editing"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,11 +1,3 @@
|
||||
// Replace this with your own font imports!
|
||||
@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&family=Source+Sans+Pro:wght@400;600&display=swap');
|
||||
:root {
|
||||
--font-body: "PP Mori", "Source Sans Pro", sans-serif;
|
||||
--font-header: "PP Mori", "Source Sans Pro", sans-serif;
|
||||
--font-mono: "PP Fraktion Mono", "Fira Code", monospace;
|
||||
}
|
||||
|
||||
// typography
|
||||
html {
|
||||
scroll-behavior: smooth;
|
||||
|
||||
@ -1,30 +1 @@
|
||||
// Add your own CSS here!
|
||||
|
||||
:root {
|
||||
--light: #faf8f8;
|
||||
--dark: #141021;
|
||||
--secondary: #7c00ce;
|
||||
--tertiary: #ff48d4;
|
||||
--visited: #afbfc9;
|
||||
--primary: #f28482;
|
||||
--gray: #3f3f3f;
|
||||
--lightgray: #f0f0f0;
|
||||
--outlinegray: #dadada;
|
||||
--million-progress-bar-color: var(--secondary);
|
||||
--highlighted: #8446ff88;
|
||||
--header: #bca1ff;
|
||||
}
|
||||
|
||||
[saved-theme="dark"] {
|
||||
--light: #1e1e21 !important;
|
||||
--dark: #f7f2fa !important;
|
||||
--secondary: #b866ff !important;
|
||||
--visited: #d199ff !important;
|
||||
--tertiary: #92a8ff !important;
|
||||
--primary: #f58382 !important;
|
||||
--gray: #d4d4d4 !important;
|
||||
--lightgray: #292633 !important;
|
||||
--outlinegray: #343434 !important;
|
||||
--highlighted: #574010;
|
||||
--header: #7838f8;
|
||||
}
|
||||
42
config.yaml
42
config.yaml
@ -1,5 +1,5 @@
|
||||
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
||||
baseURL: https://notes.bencuan.me
|
||||
baseURL: https://amethyst.bencuan.me
|
||||
|
||||
# Book configuration
|
||||
disablePathToLower: true
|
||||
@ -18,6 +18,7 @@ markup:
|
||||
# See https://gohugo.io/content-management/multilingual/#translation-by-filename
|
||||
# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
|
||||
# Sidebar menu additional links
|
||||
menu:
|
||||
# before:
|
||||
# - name: "Sample"
|
||||
@ -36,22 +37,37 @@ params:
|
||||
# OPTIONAL: custom favicon location
|
||||
# favicon: 'location/to/favicon.png'
|
||||
|
||||
# Show previews for links to other internal pages.
|
||||
# whether to display on-hover link preview cards
|
||||
enableLinkPreview: true
|
||||
|
||||
# Enable rendering of LaTeX blocks
|
||||
# (surrounded by either single or double dollar signs)
|
||||
enableLatex: true
|
||||
|
||||
# whether to render titles for code blocks
|
||||
enableCodeBlockTitle: true
|
||||
|
||||
# whether to render copy buttons for code blocks
|
||||
enableCodeBlockCopy: true
|
||||
|
||||
# whether to render callouts
|
||||
enableCallouts: true
|
||||
enableSPA: false
|
||||
|
||||
# Show footer, including backlinks and graph view
|
||||
enableFooter: true
|
||||
|
||||
# whether backlinks of pages should show the context in which
|
||||
# they were mentioned
|
||||
enableContextualBacklinks: true
|
||||
|
||||
# whether to show a section of recent notes on the home page
|
||||
enableRecentNotes: false
|
||||
|
||||
# whether to display an 'edit' button next to the last edited field
|
||||
# that links to github
|
||||
enableGitHubEdit: true
|
||||
|
||||
# whether to render mermaid diagrams
|
||||
enableMermaid: true
|
||||
|
||||
# Link to your Github repo
|
||||
@ -114,10 +130,6 @@ params:
|
||||
# - In blog posts
|
||||
BookDateFormat: "January 2, 2006"
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch: true
|
||||
|
||||
# (Optional, default true) Enables comments template on pages
|
||||
# By default partals/docs/comments.html includes Disqus template
|
||||
@ -125,18 +137,12 @@ params:
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments: true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
# Theme will print warning if page referenced in markdown does not exists.
|
||||
BookPortableLinks: true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
||||
BookServiceWorker: false
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
|
||||
BookTranslatedOnly: false
|
||||
|
||||
|
||||
# Don't change this
|
||||
enableSPA: false
|
||||
BookSearch: false
|
||||
BookServiceWorker: false
|
||||
BookPortableLinks: false
|
||||
@ -1,28 +1,33 @@
|
||||
---
|
||||
title: 🪴 Quartz 3.
|
||||
title: 💜 Welcome to Amethyst!
|
||||
enableToc: false
|
||||
---
|
||||
|
||||
Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features
|
||||
## What is Amethyst?
|
||||
Amethyst is a free [Obsidian Publish](https://obsidian.md/publish) alternative that is derived from two existing projects, [Quartz](https://quartz.jzhao.xyz/) and [Hugo Book](https://github.com/alex-shpak/hugo-book).
|
||||
|
||||
1. Extremely fast natural-language [[notes/search]]
|
||||
2. Customizable and hackable design based on [Hugo](https://gohugo.io/)
|
||||
3. Automatically generated backlinks, link previews, and local graph
|
||||
4. Built-in [[notes/CJK + Latex Support (测试) | CJK + Latex Support]] and [[notes/callouts | Admonition-style callouts]]
|
||||
5. Support for both Markdown Links and Wikilinks
|
||||
The purpose of Amethyst is to provide a space to publish more structured notes created in Obsidian that may not fit in the [digital garden](https://joelhooks.com/digital-garden/) archetype that is well-supported by existing projects.
|
||||
|
||||
Check out some of the [amazing gardens that community members](notes/showcase.md) have published with Quartz or read about [why I made Quartz](notes/philosophy.md) to begin with.
|
||||
Amethyst was primarily created as a theme for my [course notes](https://notes.bencuan.me).
|
||||
|
||||
## Get Started
|
||||
> 📚 Step 1: [Setup your own digital garden using Quartz](notes/setup.md)
|
||||
> 📚 Step 1: [Setup your own Amethyst instance](setup/setup.md)
|
||||
|
||||
Returning user? Figure out how to [[notes/updating|update]] your existing Quartz garden.
|
||||
> ✏️ Step 2: [Editing Notes in Amethyst](setup/editing.md)
|
||||
|
||||
If you prefer browsing the contents of this site through a list instead of a graph, you see a list of all [setup-related notes](/tags/setup).
|
||||
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Amethyst](setup/obsidian.md)
|
||||
|
||||
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||
|
||||
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||
|
||||
> 🎨 Step 6: [Customizing Amethyst](setup/config.md)
|
||||
|
||||
Returning user? Here's how to [[setup/updating|update]] your existing Amethyst instance.
|
||||
|
||||
Here's a list of all [setup-related notes](/tags/setup), which are also accessible via the sidebar menu under the "Getting Started" section.
|
||||
|
||||
### Troubleshooting
|
||||
- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
|
||||
- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
|
||||
- 👀 [Discord Community](https://discord.gg/cRFFHYye7t)
|
||||
|
||||
[[notes/foo]] [[notes/foo/footest]]
|
||||
- 🚧 [Troubleshooting and FAQ](setup/troubleshooting.md)
|
||||
- 🐛 [Submit an Issue](https://github.com/64bitpandas/amethyst/issues)
|
||||
- 👀 [Contact me](https://bencuan.me/contact)
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
linkTitle: "Configuration"
|
||||
weight: -5
|
||||
---
|
||||
@ -1,228 +0,0 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
tags:
|
||||
- setup
|
||||
weight: 0
|
||||
---
|
||||
|
||||
## Configuration
|
||||
Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.
|
||||
|
||||
The majority of configuration can be found under `data/config.yaml`. An annotated example configuration is shown below.
|
||||
|
||||
```yaml {title="data/config.yaml"}
|
||||
# The name to display in the footer
|
||||
name: Jacky Zhao
|
||||
|
||||
# whether to globally show the table of contents on each page
|
||||
# this can be turned off on a per-page basis by adding this to the
|
||||
# front-matter of that note
|
||||
enableToc: true
|
||||
|
||||
# whether to by-default open or close the table of contents on each page
|
||||
openToc: false
|
||||
|
||||
# whether to display on-hover link preview cards
|
||||
enableLinkPreview: true
|
||||
|
||||
# whether to render titles for code blocks
|
||||
enableCodeBlockTitle: true
|
||||
|
||||
# whether to render copy buttons for code blocks
|
||||
enableCodeBlockCopy: true
|
||||
|
||||
# whether to render callouts
|
||||
enableCallouts: true
|
||||
|
||||
# whether to try to process Latex
|
||||
enableLatex: true
|
||||
|
||||
# whether to enable single-page-app style rendering
|
||||
# this prevents flashes of unstyled content and improves
|
||||
# smoothness of Quartz. More info in issue #109 on GitHub
|
||||
enableSPA: true
|
||||
|
||||
# whether to render a footer
|
||||
enableFooter: true
|
||||
|
||||
# whether backlinks of pages should show the context in which
|
||||
# they were mentioned
|
||||
enableContextualBacklinks: true
|
||||
|
||||
# whether to show a section of recent notes on the home page
|
||||
enableRecentNotes: false
|
||||
|
||||
# whether to display an 'edit' button next to the last edited field
|
||||
# that links to github
|
||||
enableGitHubEdit: true
|
||||
GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content
|
||||
|
||||
# whether to render mermaid diagrams
|
||||
enableMermaid: true
|
||||
|
||||
# whether to use Operand to power semantic search
|
||||
# IMPORTANT: replace this API key with your own if you plan on using
|
||||
# Operand search!
|
||||
search:
|
||||
enableSemanticSearch: false
|
||||
operandApiKey: "REPLACE-WITH-YOUR-OPERAND-API-KEY"
|
||||
operandIndexId: "REPLACE-WITH-YOUR-OPERAND-INDEX-ID"
|
||||
|
||||
# page description used for SEO
|
||||
description:
|
||||
Host your second brain and digital garden for free. Quartz features extremely fast full-text search,
|
||||
Wikilink support, backlinks, local graph, tags, and link previews.
|
||||
|
||||
# title of the home page (also for SEO)
|
||||
page_title:
|
||||
"🪴 Quartz 3.3"
|
||||
|
||||
# links to show in the footer
|
||||
links:
|
||||
- link_name: Twitter
|
||||
link: https://twitter.com/_jzhao
|
||||
- link_name: Github
|
||||
link: https://github.com/jackyzha0
|
||||
```
|
||||
|
||||
### Code Block Titles
|
||||
To add code block titles with Quartz:
|
||||
|
||||
1. Ensure that code block titles are enabled in Quartz's configuration:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
enableCodeBlockTitle: true
|
||||
```
|
||||
|
||||
2. Add the `title` attribute to the desired [code block
|
||||
fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):
|
||||
|
||||
```markdown {linenos=false}
|
||||
```yaml {title="data/config.yaml"}
|
||||
enableCodeBlockTitle: true # example from step 1
|
||||
```
|
||||
```
|
||||
|
||||
**Note** that if `{title=<my-title>}` is included, and code block titles are not
|
||||
enabled, no errors will occur, and the title attribute will be ignored.
|
||||
|
||||
### HTML Favicons
|
||||
If you would like to customize the favicons of your Quartz-based website, you
|
||||
can add them to the `data/config.yaml` file. The **default** without any set
|
||||
`favicon` key is:
|
||||
|
||||
```html {title="layouts/partials/head.html", linenostart=15}
|
||||
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||
```
|
||||
|
||||
The default can be overridden by defining a value to the `favicon` key in your
|
||||
`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is
|
||||
equivalent to the default:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
favicon:
|
||||
- { rel: "shortcut icon", href: "icon.png", type: "image/png" }
|
||||
# - { ... } # Repeat for each additional favicon you want to add
|
||||
```
|
||||
|
||||
In this format, the keys are identical to their HTML representations.
|
||||
|
||||
If you plan to add multiple favicons generated by a website (see list below), it
|
||||
may be easier to define it as HTML. Here is an example which appends the
|
||||
**Apple touch icon** to Quartz's default favicon:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
favicon: |
|
||||
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
|
||||
```
|
||||
|
||||
This second favicon will now be used as a web page icon when someone adds your
|
||||
webpage to the home screen of their Apple device. If you are interested in more
|
||||
information about the current and past standards of favicons, you can read
|
||||
[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).
|
||||
|
||||
**Note** that all generated favicon paths, defined by the `href`
|
||||
attribute, are relative to the `static/` directory.
|
||||
|
||||
### Graph View
|
||||
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.
|
||||
|
||||
```yaml {title="data/graphConfig.yaml"}
|
||||
# if true, a Global Graph will be shown on home page with full width, no backlink.
|
||||
# A different set of Local Graphs will be shown on sub pages.
|
||||
# if false, Local Graph will be default on every page as usual
|
||||
enableGlobalGraph: false
|
||||
|
||||
### Local Graph ###
|
||||
localGraph:
|
||||
# whether automatically generate a legend
|
||||
enableLegend: false
|
||||
|
||||
# whether to allow dragging nodes in the graph
|
||||
enableDrag: true
|
||||
|
||||
# whether to allow zooming and panning the graph
|
||||
enableZoom: true
|
||||
|
||||
# how many neighbours of the current node to show (-1 is all nodes)
|
||||
depth: 1
|
||||
|
||||
# initial zoom factor of the graph
|
||||
scale: 1.2
|
||||
|
||||
# how strongly nodes should repel each other
|
||||
repelForce: 2
|
||||
|
||||
# how strongly should nodes be attracted to the center of gravity
|
||||
centerForce: 1
|
||||
|
||||
# what the default link length should be
|
||||
linkDistance: 1
|
||||
|
||||
# how big the node labels should be
|
||||
fontSize: 0.6
|
||||
|
||||
# scale at which to start fading the labes on nodes
|
||||
opacityScale: 3
|
||||
|
||||
### Global Graph ###
|
||||
globalGraph:
|
||||
# same settings as above
|
||||
|
||||
### For all graphs ###
|
||||
# colour specific nodes path off of their path
|
||||
paths:
|
||||
- /moc: "#4388cc"
|
||||
```
|
||||
|
||||
|
||||
## Styling
|
||||
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
|
||||
|
||||
### Partials
|
||||
Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
|
||||
|
||||
For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`
|
||||
|
||||
More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)
|
||||
|
||||
Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
|
||||
|
||||
## Language Support
|
||||
[CJK + Latex Support (测试)](notes/CJK%20+%20Latex%20Support%20(测试).md) comes out of the box with Quartz.
|
||||
|
||||
Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.
|
||||
|
||||
Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml`
|
||||
|
||||
For example:
|
||||
|
||||
```toml
|
||||
defaultContentLanguage = 'ar'
|
||||
[languages]
|
||||
[languages.ar]
|
||||
languagedirection = 'rtl'
|
||||
title = 'مدونتي'
|
||||
weight = 1
|
||||
```
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
title: "Hosting with Docker"
|
||||
tags:
|
||||
- setup
|
||||
---
|
||||
|
||||
If you want to host Quartz on a machine without using a webpage hosting service, it may be easier to [install Docker Compose](https://docs.docker.com/compose/install/) and follow the instructions below than to [install Quartz's dependencies manually](notes/preview%20changes.md).
|
||||
## Hosting Quartz Locally
|
||||
You can serve Quartz locally at `http://localhost:1313` with the following script, replacing `/path/to/quartz` with the
|
||||
actual path to your Quartz folder.
|
||||
|
||||
docker-compose.yml
|
||||
```
|
||||
services:
|
||||
quartz-hugo:
|
||||
image: ghcr.io/jackyzha0/quartz:hugo
|
||||
container_name: quartz-hugo
|
||||
volumes:
|
||||
- /path/to/quartz:/quartz
|
||||
ports:
|
||||
- 1313:1313
|
||||
|
||||
# optional
|
||||
environment:
|
||||
- HUGO_BIND=0.0.0.0
|
||||
- HUGO_BASEURL=http://localhost
|
||||
- HUGO_PORT=1313
|
||||
- HUGO_APPENDPORT=true
|
||||
```
|
||||
|
||||
Then run with: `docker-compose up -d` in the same directory as your `docker-compose.yml` file.
|
||||
|
||||
While the container is running, you can update the `quartz` fork with: `docker exec -it quartz-hugo make update`.
|
||||
|
||||
## Exposing Your Container to the Internet
|
||||
|
||||
### To Your Public IP Address with Port Forwarding (insecure)
|
||||
|
||||
Assuming you are already familiar with [port forwarding](https://en.wikipedia.org/wiki/Port_forwarding) and [setting it up with your router model](https://portforward.com):
|
||||
|
||||
1. You should set the environment variable `HUGO_BASEURL=http://your-public-ip` and then start your container.
|
||||
2. Set up port forwarding on your router from port `p` to `your-local-ip:1313`.
|
||||
3. You should now be able to access Quartz from outside your local network at `http://your-public-ip:p`.
|
||||
|
||||
However, your HTTP connection will be unencrypted and **this method is not secure**.
|
||||
|
||||
### To a Domain using Cloudflare Proxy
|
||||
|
||||
1. Port forward 443 (HTTPS) from your machine.
|
||||
2. Buy a custom domain (say, `your-domain.com`) from [Cloudflare](https://www.cloudflare.com/products/registrar/). Point a DNS A record from `your-domain.com` to your public IP address and enable the proxy.
|
||||
3. Set the environment variables `HUGO_BASEURL=https://your-domain.com`, `HUGO_PORT=443`, and `HUGO_APPENDPORT=false`. Change `1313:1313` to `443:443` for the `ports` in `docker-compose.yml`.
|
||||
4. Spin up your Quartz container and enjoy it at `https://your-domain.com`!
|
||||
|
||||
### To a Domain using a Reverse Proxy
|
||||
|
||||
If you want to serve more than just Quartz to the internet on this machine (or don't want to use the Cloudflare registrar and proxy), you should follow the steps in the section above (as appropriate) and also set up a reverse proxy, like [Traefik](https://doc.traefik.io/traefik). Be sure to configure your TLS certificates too!
|
||||
@ -1,66 +0,0 @@
|
||||
---
|
||||
title: "Editing Content in Quartz"
|
||||
tags:
|
||||
- setup
|
||||
weight: -4
|
||||
---
|
||||
|
||||
## Editing
|
||||
Quartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
|
||||
|
||||
### Folder Structure
|
||||
Here's a rough overview of what's what.
|
||||
|
||||
**All content in your garden can found in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you'd like.
|
||||
|
||||
**To edit the main home page, open `/content/_index.md`.**
|
||||
|
||||
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
|
||||
|
||||
```markdown
|
||||
For example, I want to link this current document to `notes/config.md`.
|
||||
[A link to the config page](notes/config.md)
|
||||
```
|
||||
|
||||
Similarly, you can put local images anywhere in the `/content` folder.
|
||||
|
||||
```markdown
|
||||
Example image (source is in content/notes/images/example.png)
|
||||
|
||||
```
|
||||
|
||||
You can also use wikilinks if that is what you are more comfortable with!
|
||||
|
||||
### Front Matter
|
||||
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Example Title"
|
||||
tags:
|
||||
- example-tag
|
||||
---
|
||||
|
||||
Rest of your content here...
|
||||
```
|
||||
|
||||
### Obsidian
|
||||
I recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.
|
||||
|
||||
This step is **highly recommended**.
|
||||
|
||||
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)
|
||||
|
||||
## Previewing Changes
|
||||
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required.
|
||||
|
||||
> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md)
|
||||
|
||||
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
|
||||
|
||||
## Publishing Changes
|
||||
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
|
||||
|
||||
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)
|
||||
|
||||
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
|
||||
@ -1,95 +0,0 @@
|
||||
---
|
||||
title: "Deploying Quartz to the Web"
|
||||
tags:
|
||||
- setup
|
||||
aliases:
|
||||
- hosting
|
||||
---
|
||||
|
||||
## Hosting on GitHub Pages
|
||||
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.
|
||||
|
||||
### Enable GitHub Actions
|
||||
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
|
||||
|
||||
*Enable GitHub Actions*
|
||||
|
||||
### Enable GitHub Pages
|
||||
|
||||
Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab.
|
||||
|
||||
1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`
|
||||
2. Set a custom domain here if you have one!
|
||||
|
||||
*Enable GitHub Pages*
|
||||
|
||||
### Pushing Changes
|
||||
To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project.
|
||||
|
||||
```shell
|
||||
# Navigate to Quartz folder
|
||||
cd <path-to-quartz>
|
||||
|
||||
# Commit all changes
|
||||
git add .
|
||||
git commit -m "message describing changes"
|
||||
|
||||
# Push to GitHub to update site
|
||||
git push origin hugo
|
||||
```
|
||||
|
||||
Note: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment.
|
||||
|
||||
### Setting up the Site
|
||||
Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too.
|
||||
|
||||
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
|
||||
|
||||
Make sure that your `baseURL` has a trailing `/`!
|
||||
|
||||
[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)
|
||||
|
||||
```toml
|
||||
baseURL = "https://<YOUR-DOMAIN>/"
|
||||
```
|
||||
|
||||
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!**
|
||||
|
||||
```toml
|
||||
baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
|
||||
```
|
||||
|
||||
Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`.
|
||||
|
||||
Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.
|
||||
|
||||
[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
|
||||
|
||||
```yaml {title=".github/workflows/deploy.yaml"}
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!
|
||||
publish_dir: ./public
|
||||
publish_branch: master
|
||||
cname: <YOUR-DOMAIN>
|
||||
```
|
||||
|
||||
Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).
|
||||
|
||||
### Ignoring Files
|
||||
Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.
|
||||
|
||||
❌ [Excluding pages from being published](notes/ignore%20notes.md)
|
||||
|
||||
## Docker Support
|
||||
If you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead!
|
||||
I would *not use this method* unless you know what you are doing.
|
||||
|
||||
---
|
||||
|
||||
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
|
||||
|
||||
> Step 6: 🎨 [Customizing Quartz](notes/config.md)
|
||||
|
||||
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
|
||||
@ -4,7 +4,7 @@ title: "Callouts"
|
||||
|
||||
## Callout support
|
||||
|
||||
Quartz supports the same Admonition-callout syntax as Obsidian.
|
||||
Amethyst supports the same Admonition-callout syntax as Obsidian.
|
||||
|
||||
This includes
|
||||
- 12 Distinct callout types (each with several aliases)
|
||||
|
||||
@ -10,4 +10,4 @@ title: "Chinese, Japanese, Korean Support (测试)"
|
||||
私たちがそれを知るほぼ前に、私たちは地面を離れていました。
|
||||
|
||||
## RTL
|
||||
More information on configuring RTL languages like Arabic in the [config](notes/config.md) page.
|
||||
More information on configuring RTL languages like Arabic in the [config](setup/config.md) page.
|
||||
|
||||
4
content/setup/_index.md
Normal file
4
content/setup/_index.md
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
linkTitle: "Getting Started"
|
||||
weight: -5
|
||||
---
|
||||
114
content/setup/config.md
Normal file
114
content/setup/config.md
Normal file
@ -0,0 +1,114 @@
|
||||
---
|
||||
title: "Customization"
|
||||
tags:
|
||||
- setup
|
||||
weight: 0
|
||||
---
|
||||
|
||||
# Configuration
|
||||
Amethyst is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.
|
||||
|
||||
The majority of configuration can be found under `config.yaml`. An example, with descriptions for each setting, can be found [here](https://github.com/64bitpandas/amethyst/blob/main/config.yaml).
|
||||
|
||||
### Code Block Titles
|
||||
To add code block titles with Amethyst:
|
||||
|
||||
1. Ensure that code block titles are enabled in the configuration:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
enableCodeBlockTitle: true
|
||||
```
|
||||
|
||||
2. Add the `title` attribute to the desired [code block
|
||||
fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):
|
||||
|
||||
```markdown {linenos=false}
|
||||
```yaml {title="data/config.yaml"}
|
||||
enableCodeBlockTitle: true # example from step 1
|
||||
```
|
||||
```
|
||||
|
||||
**Note** that if `{title=<my-title>}` is included, and code block titles are not
|
||||
enabled, no errors will occur, and the title attribute will be ignored.
|
||||
|
||||
### HTML Favicons
|
||||
If you would like to customize the favicons, you
|
||||
can add them to the `data/config.yaml` file. The **default** without any set
|
||||
`favicon` key is:
|
||||
|
||||
```html {title="layouts/partials/head.html", linenostart=15}
|
||||
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||
```
|
||||
|
||||
The default can be overridden by defining a value to the `favicon` key in your
|
||||
`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is
|
||||
equivalent to the default:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
favicon:
|
||||
- { rel: "shortcut icon", href: "icon.png", type: "image/png" }
|
||||
# - { ... } # Repeat for each additional favicon you want to add
|
||||
```
|
||||
|
||||
In this format, the keys are identical to their HTML representations.
|
||||
|
||||
If you plan to add multiple favicons generated by a website (see list below), it
|
||||
may be easier to define it as HTML. Here is an example which appends the
|
||||
**Apple touch icon** to Amethyst's default favicon:
|
||||
|
||||
```yaml {title="data/config.yaml", linenos=false}
|
||||
favicon: |
|
||||
<link rel="shortcut icon" href="icon.png" type="image/png">
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
|
||||
```
|
||||
|
||||
This second favicon will now be used as a web page icon when someone adds your
|
||||
webpage to the home screen of their Apple device. If you are interested in more
|
||||
information about the current and past standards of favicons, you can read
|
||||
[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).
|
||||
|
||||
**Note** that all generated favicon paths, defined by the `href`
|
||||
attribute, are relative to the `static/` directory.
|
||||
|
||||
### Graph View
|
||||
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`. The default configuration, with descriptions, can be found [here](https://github.com/64bitpandas/amethyst/blob/main/data/graphConfig.yaml).
|
||||
|
||||
### Language Support
|
||||
[Chinese, Japanese, and Korean support](features/language.md) comes out of the box with Amethyst.
|
||||
|
||||
Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Amethyst) supports this natively.
|
||||
|
||||
Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.yaml`
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
defaultContentLanguage: ar
|
||||
languages:
|
||||
ar:
|
||||
languagedirection: rtl
|
||||
title: مدونتي
|
||||
weight: 2
|
||||
```
|
||||
|
||||
# Custom Styles
|
||||
Want to go even more in-depth? You can add custom CSS styling in `assets/_custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
|
||||
|
||||
### Changing the Color Scheme
|
||||
The default color schemes for light mode and dark mode are located in `assets/_colors.scss`. You can replace the values for existing color variables for drop-in edits, or create new variables to reference in `_custom.scss`.
|
||||
|
||||
### Changing the Fonts
|
||||
All fonts are defined in `assets/_fonts.scss`. There are examples for both local fonts (defined using `@font-face`) and webfonts (fetched with `@import` from a font distributor such as Google Fonts).
|
||||
|
||||
You can place all local fonts in the `static/fonts` folder.
|
||||
|
||||
### Partials
|
||||
Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
|
||||
|
||||
For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`
|
||||
|
||||
More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)
|
||||
|
||||
Still having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||
|
||||
|
||||
@ -9,9 +9,9 @@ For this last bit to take effect, you also need to create a CNAME record with th
|
||||
|
||||
GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to
|
||||
|
||||
1. Go to your forked repository (`github.com/<YOUR-GITHUB-USERNAME>/quartz`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**.
|
||||
1. Go to your forked repository (`github.com/<YOUR-GITHUB-USERNAME>/amethyst`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**.
|
||||
2. Go to your DNS Provider and create a CNAME record that points from your domain to `<YOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).
|
||||
|
||||
*Example Configuration for Quartz*
|
||||
*Example Configuration for Quartz*
|
||||
3. Wait 30 minutes to an hour for the network changes to kick in.
|
||||
4. Done!
|
||||
98
content/setup/editing.md
Normal file
98
content/setup/editing.md
Normal file
@ -0,0 +1,98 @@
|
||||
---
|
||||
title: "Editing Content"
|
||||
tags:
|
||||
- setup
|
||||
weight: -4
|
||||
---
|
||||
|
||||
## Editing
|
||||
Amethyst runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
|
||||
|
||||
### Folder Structure
|
||||
Here's a rough overview of what's what.
|
||||
|
||||
**All notes you want to publish should go in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any subfolder you'd like.
|
||||
|
||||
**To edit the main home page, open `/content/_index.md`.**
|
||||
|
||||
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
|
||||
|
||||
```markdown
|
||||
For example, I want to link this current document to `setup/config.md`.
|
||||
[A link to the config page](setup/config.md)
|
||||
```
|
||||
|
||||
Similarly, you can put local images anywhere in the `/content` folder.
|
||||
|
||||
```markdown
|
||||
Example image (source is in content/setup/images/example.png)
|
||||
|
||||
```
|
||||
|
||||
You can also use wikilinks if that is what you are more comfortable with!
|
||||
|
||||
### Front Matter
|
||||
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file in the front matter like so. You can also add tags here as well.
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Example Title"
|
||||
tags:
|
||||
- example-tag
|
||||
---
|
||||
|
||||
Rest of your content here...
|
||||
```
|
||||
|
||||
You can specify additional params in the front matter of individual pages:
|
||||
|
||||
```toml
|
||||
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
|
||||
type = 'docs'
|
||||
|
||||
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
|
||||
weight = 10
|
||||
|
||||
# (Optional) Set to 'true' to mark page as flat section in file-tree menu (if BookMenuBundle not set)
|
||||
bookFlatSection = false
|
||||
|
||||
# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode
|
||||
bookCollapseSection = true
|
||||
|
||||
# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set)
|
||||
bookHidden = false
|
||||
|
||||
# (Optional) Set 'false' to hide ToC from page
|
||||
bookToC = true
|
||||
|
||||
# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages.
|
||||
bookComments = true
|
||||
|
||||
# (Optional) Set to 'false' to exclude page from search index.
|
||||
bookSearchExclude = true
|
||||
|
||||
# (Optional) Set explicit href attribute for this page in a menu (if BookMenuBundle not set)
|
||||
bookHref = ''
|
||||
```
|
||||
|
||||
|
||||
### Obsidian
|
||||
Amethyst is built especially for use with [Obsidian](http://obsidian.md/) as a text editor.
|
||||
|
||||
See below for more information:
|
||||
|
||||
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Amethyst](setup/obsidian.md)
|
||||
|
||||
## Previewing Changes
|
||||
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required.
|
||||
|
||||
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||
|
||||
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
|
||||
|
||||
## Publishing Changes
|
||||
After you've finished editing your notes, you can publish them to the internet!
|
||||
|
||||
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||
|
||||
Having problems? Check out our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||
93
content/setup/hosting.md
Normal file
93
content/setup/hosting.md
Normal file
@ -0,0 +1,93 @@
|
||||
---
|
||||
title: "Deploying Amethyst to the Web"
|
||||
tags:
|
||||
- setup
|
||||
aliases:
|
||||
- hosting
|
||||
---
|
||||
|
||||
## Hosting on GitHub Pages
|
||||
Amethyst is designed to be effortless to deploy. If you forked and cloned Amethyst directly from the repository, everything should already be good to go! Follow the steps below.
|
||||
|
||||
### Enable GitHub Actions
|
||||
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your site!
|
||||
|
||||
*Enable GitHub Actions*
|
||||
|
||||
### Enable GitHub Pages
|
||||
|
||||
Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab.
|
||||
|
||||
1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`
|
||||
2. Set a custom domain here if you have one!
|
||||
|
||||
*Enable GitHub Pages*
|
||||
|
||||
### Pushing Changes
|
||||
To see your changes on the internet, we need to push it them to GitHub. Amethyst is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project.
|
||||
|
||||
```shell
|
||||
# Navigate to Amethyst folder
|
||||
cd <path-to-amethyst>
|
||||
|
||||
# Commit all changes
|
||||
git add .
|
||||
git commit -m "message describing changes"
|
||||
|
||||
# Push to GitHub to update site
|
||||
git push origin main
|
||||
```
|
||||
|
||||
Note: we specifically push to the `main` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `deploy` branch for redeployment.
|
||||
|
||||
### Setting up the Site
|
||||
Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to use a subdomain? That's easy too.
|
||||
|
||||
> Don't want to use GitHub Pages? Continue following the instructions below, and simply point your hosting solution to serve the `deploy` branch with no additional build steps required.
|
||||
|
||||
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
|
||||
|
||||
Make sure that your `baseURL` has a trailing `/`!
|
||||
|
||||
[Reference `config.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/config.yaml)
|
||||
|
||||
```yaml
|
||||
baseURL: "https://<YOUR-DOMAIN>/"
|
||||
```
|
||||
|
||||
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/amethyst/`), include the trailing `/`. **You need to do this especially if you are using GitHub!**
|
||||
|
||||
```yaml
|
||||
baseURL: "https://<YOUR-GITHUB-USERNAME>.github.io/amethyst/"
|
||||
```
|
||||
|
||||
Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`.
|
||||
|
||||
Please note that the `cname` field should *not* have any path `e.g. end with /amethyst` or have a trailing `/`.
|
||||
|
||||
[Reference `deploy.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/.github/workflows/deploy.yaml)
|
||||
|
||||
```yaml {title=".github/workflows/deploy.yaml"}
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!
|
||||
publish_dir: ./public
|
||||
publish_branch: deploy
|
||||
cname: <YOUR-DOMAIN>
|
||||
```
|
||||
|
||||
Have a custom domain? [Learn how to set it up with Amethyst ](setup/custom%20Domain.md).
|
||||
|
||||
### Ignoring Files
|
||||
Only want to publish a subset of all of your notes? Don't worry, Amethyst makes this a simple two-step process.
|
||||
|
||||
❌ [Excluding pages from being published](setup/ignore%20notes.md)
|
||||
|
||||
---
|
||||
|
||||
Now that your site is live, let's figure out how to make Amethyst really *yours*!
|
||||
|
||||
> Step 6: 🎨 [Customizing Amethyst](setup/config.md)
|
||||
|
||||
Having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||
@ -2,12 +2,11 @@
|
||||
title: "Ignoring Notes"
|
||||
---
|
||||
|
||||
### Quartz Ignore
|
||||
Edit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered.
|
||||
Edit `ignoreFiles` in `config.yaml` to include paths you'd like to exclude from being rendered.
|
||||
|
||||
```toml
|
||||
...
|
||||
ignoreFiles = [
|
||||
ignoreFiles: [
|
||||
"/content/templates/*",
|
||||
"/content/private/*",
|
||||
"<your path here>"
|
||||
@ -28,4 +27,4 @@ draft: true
|
||||
More details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering).
|
||||
|
||||
### Global Ignore
|
||||
However, just adding to the `ignoreFiles` will only prevent the page from being access through Quartz. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the `.gitignore` file at the root of the repository.
|
||||
However, just adding to the `ignoreFiles` will only prevent the page from being access through Amethyst. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the `.gitignore` file at the root of the repository.
|
||||
|
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 226 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
@ -6,21 +6,29 @@ weight: -3
|
||||
---
|
||||
|
||||
## Setup
|
||||
Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
|
||||
Obsidian is the preferred way to use Amethyst. You can either create a new Obsidian Vault or link one that your already have.
|
||||
|
||||
### New Vault
|
||||
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step.
|
||||
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](setup/setup.md) step.
|
||||
|
||||
### Linking an existing Vault
|
||||
### Linking an existing Vault (simple)
|
||||
The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.
|
||||
|
||||
### Linking an existing Vault (using git)
|
||||
If you're editing in an existing vault and don't want to have to keep copying your files over, one solution is to create a new Git repository for just the notes you want to publish.
|
||||
|
||||
Then, in both your vault and in Amethyst, run the following command, replacing the link with one to your new repository:
|
||||
```bash
|
||||
git submodule add https://github.com/<YOUR_USERNAME>/<REPO_NAME> content
|
||||
```
|
||||
|
||||
## Settings
|
||||
Great, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.
|
||||
Now that you've added your notes to Amethyst, let's fix some settings so that they play well.
|
||||
|
||||
1. Under Options > Files and Links, set the New link format to always use Absolute Path in Vault.
|
||||
2. Go to Settings > Files & Links > Turn "on" automatically update internal links.
|
||||
|
||||
*Obsidian Settings*
|
||||
*Obsidian Settings*
|
||||
|
||||
## Templates
|
||||
Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.
|
||||
@ -29,4 +37,4 @@ Inserting front matter everytime you want to create a new Note gets annoying rea
|
||||
|
||||
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template' (I recommend `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
|
||||
|
||||
> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md)
|
||||
> 👀 Step 4: [Preview Changes](setup/preview%20changes.md)
|
||||
@ -5,7 +5,7 @@ tags:
|
||||
weight: -2
|
||||
---
|
||||
|
||||
If you'd like to preview what your Quartz site looks like before deploying it to the internet, the following
|
||||
If you'd like to preview what your site looks like before deploying it to the internet, the following
|
||||
instructions guide you through installing the proper dependencies to run it locally.
|
||||
|
||||
|
||||
@ -22,11 +22,11 @@ If you are running into an error saying that `command not found: hugo-obsidian`,
|
||||
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
|
||||
|
||||
## Installing Hugo
|
||||
Hugo is the static site generator that powers Quartz. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,
|
||||
Hugo is the static site generator that powers Amethyst. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,
|
||||
|
||||
```bash
|
||||
# Navigate to your local Quartz folder
|
||||
cd <location-of-your-local-quartz>
|
||||
# Navigate to your local Amethyst folder
|
||||
cd <location-of-your-local-amethyst>
|
||||
|
||||
# Start local server
|
||||
make serve
|
||||
@ -34,10 +34,6 @@ make serve
|
||||
# View your site in a browser at http://localhost:1313/
|
||||
```
|
||||
|
||||
> [!INFO] Docker Support
|
||||
>
|
||||
> If you have Docker installed already, open your terminal, navigate to your folder with Quartz and run `make docker`
|
||||
Now that you are happy with how your Amethyst instance looks, let's get it hosted!
|
||||
|
||||
Now that you are happy with how your Quartz instance looks, let's get it hosted!
|
||||
|
||||
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)
|
||||
> 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)
|
||||
@ -2,10 +2,10 @@
|
||||
title: "Search"
|
||||
---
|
||||
|
||||
Quartz supports two modes of searching through content.
|
||||
Amethyst supports two modes of searching through content.
|
||||
|
||||
## Full-text
|
||||
Full-text search is the default in Quartz. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches.
|
||||
Full-text search is the default in Amethyst. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches.
|
||||
|
||||
```yaml {title="data/config.yaml"}
|
||||
# the default option
|
||||
@ -22,7 +22,7 @@ Here's how to set it up.
|
||||
1. Login or Register for a new Operand account. Click the verification link sent to your email, and you'll be redirected to the dashboard. (Note) You do not need to enter a credit card to create an account, or get started with the Operand API. The first $10 of usage each month is free. To learn more, see pricing. If you go over your free quota, we'll (politely) reach out and ask you to configure billing.
|
||||
2. Create your first index. On the dashboard, under "Indexes", enter the name and description of your index, and click "Create Index". Note down the ID of the index (obtained by clicking on the index name in the list of indexes), as you'll need it in the next step. IDs are unique to each index, and look something like `uqv1duxxbdxu`.
|
||||
3. Click into the index you've created. Under "Index Something", select "SITEMAP" from the dropdown and click "Add Source".
|
||||
4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `quartz.jzhao.xyz`, put `https://quartz.jzhao.xyz/sitemap.xml`. Leave the URL Regex empty.
|
||||
4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `amethyst.bencuan.me`, put `https://amethyst.bencuan.me/sitemap.xml`. Leave the URL Regex empty.
|
||||
5. Get your API key. On the dashboard, under "API Keys", you can manage your API keys. If you don't already have an API key, click "Create API Key". You'll need this for the next step.
|
||||
6. Open `data/config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier..
|
||||
|
||||
@ -5,15 +5,15 @@ tags:
|
||||
weight: -5
|
||||
---
|
||||
|
||||
## Making your own Quartz
|
||||
Setting up Quartz requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start!
|
||||
## Getting Started
|
||||
Setting up Amethyst requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start!
|
||||
|
||||
### Forking
|
||||
> A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
|
||||
|
||||
Navigate to the GitHub repository for the Quartz project:
|
||||
Navigate to the GitHub repository for the Amethyst project:
|
||||
|
||||
📁 [Quartz Repository](https://github.com/jackyzha0/quartz)
|
||||
📁 [Amethyst Repository](https://github.com/64bitpandas/amethyst)
|
||||
|
||||
Then, Fork the repository into your own GitHub account. If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
|
||||
|
||||
@ -21,12 +21,12 @@ Then, Fork the repository into your own GitHub account. If you don't have an acc
|
||||
After you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command replacing `YOUR-USERNAME` with your GitHub username.
|
||||
|
||||
```shell
|
||||
git clone https://github.com/YOUR-USERNAME/quartz
|
||||
git clone https://github.com/YOUR-USERNAME/amethyst
|
||||
```
|
||||
|
||||
## Editing
|
||||
Great! Now you have everything you need to start editing and growing your digital garden. If you're ready to start writing content already, check out the recommended flow for editing notes in Quartz.
|
||||
Great! Now you have everything you need to start editing. If you're ready to start writing content already, check out the recommended flow for editing notes:
|
||||
|
||||
> ✏️ Step 2: [Editing Notes in Quartz](notes/editing.md)
|
||||
> ✏️ Step 2: [Editing Notes in Amethyst](setup/editing.md)
|
||||
|
||||
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
|
||||
Having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).
|
||||
@ -2,26 +2,24 @@
|
||||
title: "Troubleshooting and FAQ"
|
||||
---
|
||||
|
||||
Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
|
||||
Still having trouble? Here are a list of common questions and problems people encounter when installing Amethyst.
|
||||
|
||||
While you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)
|
||||
### Does Amethyst have Latex support?
|
||||
Yes! See [LaTeX](features/latex.md) for a brief demo.
|
||||
|
||||
### Does Quartz have Latex support?
|
||||
Yes! See [CJK + Latex Support (测试)](notes/CJK%20+%20Latex%20Support%20(测试).md) for a brief demo.
|
||||
|
||||
### Can I use \<Obsidian Plugin\> in Quartz?
|
||||
Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.
|
||||
### Can I use \<Obsidian Plugin\> in Amethyst?
|
||||
Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Amethyst.
|
||||
|
||||
The easiest way would be to add your own HTML partial that supports the functionality you are looking for.
|
||||
|
||||
### My GitHub pages is just showing the README and not Quartz
|
||||
Make sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide
|
||||
### My GitHub pages is just showing the README
|
||||
Make sure you set the source to deploy from the `deploy` branch (and not `main`) using `/ (root)`! See more in the [hosting](/setup/hosting) guide
|
||||
|
||||
### Some of my pages have 'January 1, 0001' as the last modified date
|
||||
This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command.
|
||||
This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Amethyst by running this command.
|
||||
|
||||
```shell
|
||||
# in the root of your Quartz (same folder as config.toml)
|
||||
# in the root folder (same folder as config.toml)
|
||||
git config core.ignorecase true
|
||||
|
||||
# or globally (not recommended)
|
||||
@ -29,10 +27,10 @@ git config --global core.ignorecase true
|
||||
```
|
||||
|
||||
### Can I publish only a subset of my pages?
|
||||
Yes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore%20notes.md).
|
||||
Yes! Amethyst makes selective publishing really easy. Heres a guide on [excluding pages from being published](setup/ignore%20notes.md).
|
||||
|
||||
### Can I host this myself and not on GitHub Pages?
|
||||
Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).
|
||||
Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](setup/hosting.md).
|
||||
|
||||
### `command not found: hugo-obsidian`
|
||||
Make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.
|
||||
@ -47,10 +45,10 @@ source ~/.bash_profile
|
||||
```
|
||||
|
||||
### How come my notes aren't being rendered?
|
||||
You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md).
|
||||
You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](setup/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](setup/editing.md).
|
||||
|
||||
### My custom domain isn't working!
|
||||
Walk through the steps in [the hosting guide](notes/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.
|
||||
Walk through the steps in [the hosting guide](setup/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.
|
||||
|
||||
### How do I setup Google Analytics?
|
||||
You can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.
|
||||
@ -59,23 +57,23 @@ You can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.
|
||||
To edit the main home page, open `/content/_index.md`.
|
||||
|
||||
### How do I change the colours?
|
||||
You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md).
|
||||
You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](setup/config.md).
|
||||
|
||||
### How do I add images?
|
||||
You can put images anywhere in the `/content` folder.
|
||||
|
||||
```markdown
|
||||
Example image (source is in content/notes/images/example.png)
|
||||
|
||||
Example image (source is in content/setup/images/example.png)
|
||||
|
||||
```
|
||||
|
||||
### My Interactive Graph and Backlinks aren't up to date
|
||||
By default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md)
|
||||
By default, the `linkIndex.json` (which Amethyst needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](setup/editing.md)
|
||||
|
||||
### Can I use React/Vue/some other framework?
|
||||
Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
|
||||
Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Amethyst is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
|
||||
|
||||
## Still Stuck?
|
||||
Quartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can.
|
||||
Amethyst isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, [send me a message](https://bencuan.me/contact) using your preferred communication method!
|
||||
|
||||
🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
|
||||
🐛 [Submit an Issue](https://github.com/64bitpandas/amethyst/issues)
|
||||
@ -4,7 +4,7 @@ aliases:
|
||||
- update
|
||||
---
|
||||
|
||||
Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made!
|
||||
Haven't updated Amethyst in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made!
|
||||
|
||||
```shell
|
||||
make update
|
||||
@ -25,10 +25,10 @@ Or, manually checkout the changes yourself.
|
||||
|
||||
|
||||
```shell
|
||||
# add Quartz as a remote host
|
||||
git remote add upstream git@github.com:jackyzha0/quartz.git
|
||||
# add Amethyst as a remote host
|
||||
git remote add upstream git@github.com:64bitpandas/amethyst.git
|
||||
|
||||
# index and fetch changes
|
||||
git fetch upstream
|
||||
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data
|
||||
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss data
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@ -1 +1 @@
|
||||
{"Target":"book.min.6741a91dfc96b335f886b059f193a9ad54e5c3a35808bee087ae3fc6c9274900.css","MediaType":"text/css","Data":{"Integrity":"sha256-Z0GpHfyWszX4hrBZ8ZOprVTlw6NYCL7gh64/xsknSQA="}}
|
||||
{"Target":"book.min.f18b2f2e7298d59ed739b8246efa7a6ed7b02ad880c55ab44840973285a77edd.css","MediaType":"text/css","Data":{"Integrity":"sha256-8YsvLnKY1Z7XObgkbvp6btewKtiAxVq0SECXMoWnft0="}}
|
||||
File diff suppressed because one or more lines are too long
@ -1 +0,0 @@
|
||||
:root{--light: #faf8f8;--dark: #141021;--secondary: #7c00ce;--tertiary: #ff48d4;--visited: #afbfc9;--primary: #f28482;--gray: #3f3f3f;--lightgray: #f0f0f0;--outlinegray: #dadada;--million-progress-bar-color: var(--secondary);--highlighted: #8446ff88;--header: #bca1ff}[saved-theme="dark"]{--light: #1e1e21 !important;--dark: #f7f2fa !important;--secondary: #b866ff !important;--visited: #d199ff !important;--tertiary: #92a8ff !important;--primary: #f58382 !important;--gray: #d4d4d4 !important;--lightgray: #292633 !important;--outlinegray: #343434 !important;--highlighted: #574010;--header: #7838f8}
|
||||
131
static/linkmap
131
static/linkmap
@ -1,74 +1,73 @@
|
||||
/example/table-of-contents//index.{html} /example/table-of-contents//
|
||||
/features//index.{html} /features//
|
||||
/features/buttons/index.{html} /features/buttons/
|
||||
/cs61b/abstract-data-types/binary-trees/tries/index.{html} /cs61b/abstract-data-types/binary-trees/tries/
|
||||
/cs61b/abstract-data-types/collections/arrays/index.{html} /cs61b/abstract-data-types/collections/arrays/
|
||||
/cs61b/abstract-data-types/graphs/index.{html} /cs61b/abstract-data-types/graphs/
|
||||
/configuration/custom-Domain/index.{html} /configuration/custom-Domain/
|
||||
/configuration/search/index.{html} /configuration/search/
|
||||
/configuration/troubleshooting/index.{html} /configuration/troubleshooting/
|
||||
/cs61b/abstract-data-types/collections/README/index.{html} /cs61b/abstract-data-types/collections/README/
|
||||
/cs61b/algorithms/shortest-paths/dijkstras-algorithm/index.{html} /cs61b/algorithms/shortest-paths/dijkstras-algorithm/
|
||||
/cs61b/asymptotics/amortization/index.{html} /cs61b/asymptotics/amortization/
|
||||
/cs61b/oop/access-control/index.{html} /cs61b/oop/access-control/
|
||||
/example/collapsed/3rd-level/4th-level/index.{html} /example/collapsed/3rd-level/4th-level/
|
||||
/features/languages/index.{html} /features/languages/
|
||||
/configuration/updating/index.{html} /configuration/updating/
|
||||
/cs61b/abstract-data-types/hashing/index.{html} /cs61b/abstract-data-types/hashing/
|
||||
/cs61b/misc-topics/modular-arithmetic/index.{html} /cs61b/misc-topics/modular-arithmetic/
|
||||
/example//index.{html} /example//
|
||||
/example/table-of-contents//index.{html} /example/table-of-contents//
|
||||
/cs61b/algorithms/minimum-spanning-trees/prims-algorithm/index.{html} /cs61b/algorithms/minimum-spanning-trees/prims-algorithm/
|
||||
/cs61b/algorithms/shortest-paths/README/index.{html} /cs61b/algorithms/shortest-paths/README/
|
||||
/features/latex/index.{html} /features/latex/
|
||||
/cs61b/algorithms/searching/depth-first-search-dfs/index.{html} /cs61b/algorithms/searching/depth-first-search-dfs/
|
||||
/example/collapsed/3rd-level//index.{html} /example/collapsed/3rd-level//
|
||||
/features/buttons/index.{html} /features/buttons/
|
||||
/features/columns/index.{html} /features/columns/
|
||||
/cs61b/abstract-data-types/collections/linked-lists/index.{html} /cs61b/abstract-data-types/collections/linked-lists/
|
||||
/cs61b/algorithms/minimum-spanning-trees/README/index.{html} /cs61b/algorithms/minimum-spanning-trees/README/
|
||||
/example/table-of-contents/with-toc/index.{html} /example/table-of-contents/with-toc/
|
||||
/features/details/index.{html} /features/details/
|
||||
/setup/preview-changes/index.{html} /setup/preview-changes/
|
||||
/setup/setup/index.{html} /setup/setup/
|
||||
/cs61b/asymptotics/asymptotics/index.{html} /cs61b/asymptotics/asymptotics/
|
||||
/cs61b/oop/generics/index.{html} /cs61b/oop/generics/
|
||||
/cs61b/algorithms/shortest-paths/a-search/index.{html} /cs61b/algorithms/shortest-paths/a-search/
|
||||
/cs61b/misc-topics/more-resources/index.{html} /cs61b/misc-topics/more-resources/
|
||||
/cs61b/oop/access-control/index.{html} /cs61b/oop/access-control/
|
||||
/example/collapsed//index.{html} /example/collapsed//
|
||||
/setup/ignore-notes/index.{html} /setup/ignore-notes/
|
||||
/cs61b/abstract-data-types/binary-trees/balanced-search-structures/index.{html} /cs61b/abstract-data-types/binary-trees/balanced-search-structures/
|
||||
/cs61b/abstract-data-types/union-find-disjoint-sets/index.{html} /cs61b/abstract-data-types/union-find-disjoint-sets/
|
||||
/features/section//index.{html} /features/section//
|
||||
/features/section/first-page/index.{html} /features/section/first-page/
|
||||
/cs61b/algorithms/minimum-spanning-trees/kruskals-algorithm/index.{html} /cs61b/algorithms/minimum-spanning-trees/kruskals-algorithm/
|
||||
/cs61b/oop/dynamic-method-selection/index.{html} /cs61b/oop/dynamic-method-selection/
|
||||
/cs61b/oop/inheritance/index.{html} /cs61b/oop/inheritance/
|
||||
/example/hidden/index.{html} /example/hidden/
|
||||
/features/mermaid/index.{html} /features/mermaid/
|
||||
/configuration/preview-changes/index.{html} /configuration/preview-changes/
|
||||
/cs61b/abstract-data-types/collections/sets/index.{html} /cs61b/abstract-data-types/collections/sets/
|
||||
/cs61b/algorithms/minimum-spanning-trees/README/index.{html} /cs61b/algorithms/minimum-spanning-trees/README/
|
||||
/configuration/editing/index.{html} /configuration/editing/
|
||||
/cs61b/asymptotics/asymptotics-practice/index.{html} /cs61b/asymptotics/asymptotics-practice/
|
||||
/features/section/second-page/index.{html} /features/section/second-page/
|
||||
/example/collapsed//index.{html} /example/collapsed//
|
||||
/cs61b/algorithms/minimax/index.{html} /cs61b/algorithms/minimax/
|
||||
/cs61b/algorithms/searching/depth-first-search-dfs/index.{html} /cs61b/algorithms/searching/depth-first-search-dfs/
|
||||
/cs61b/misc-topics/modular-arithmetic/index.{html} /cs61b/misc-topics/modular-arithmetic/
|
||||
/cs61b/algorithms/searching/dijkstras/index.{html} /cs61b/algorithms/searching/dijkstras/
|
||||
/example/collapsed/3rd-level//index.{html} /example/collapsed/3rd-level//
|
||||
/features/details/index.{html} /features/details/
|
||||
/index.html /
|
||||
/cs61b/abstract-data-types/binary-trees/balanced-search-structures/index.{html} /cs61b/abstract-data-types/binary-trees/balanced-search-structures/
|
||||
/cs61b/abstract-data-types/collections/README/index.{html} /cs61b/abstract-data-types/collections/README/
|
||||
/configuration//index.{html} /configuration//
|
||||
/cs61b/oop/objects/index.{html} /cs61b/oop/objects/
|
||||
/cs61b/sorting/sorting-basics/index.{html} /cs61b/sorting/sorting-basics/
|
||||
/cs61b/abstract-data-types/comparables-and-comparators/index.{html} /cs61b/abstract-data-types/comparables-and-comparators/
|
||||
/example/table-of-contents/without-toc/index.{html} /example/table-of-contents/without-toc/
|
||||
/configuration/setup/index.{html} /configuration/setup/
|
||||
/cs61b/abstract-data-types/binary-trees/README/index.{html} /cs61b/abstract-data-types/binary-trees/README/
|
||||
/cs61b/abstract-data-types/collections/stacks-and-queues/index.{html} /cs61b/abstract-data-types/collections/stacks-and-queues/
|
||||
/cs61b/algorithms/searching/breadth-first-search-bfs/index.{html} /cs61b/algorithms/searching/breadth-first-search-bfs/
|
||||
/cs61b/oop/generics/index.{html} /cs61b/oop/generics/
|
||||
/features/section/first-page/index.{html} /features/section/first-page/
|
||||
/configuration/config/index.{html} /configuration/config/
|
||||
/cs61b/SUMMARY/index.{html} /cs61b/SUMMARY/
|
||||
/cs61b/abstract-data-types/union-find-disjoint-sets/index.{html} /cs61b/abstract-data-types/union-find-disjoint-sets/
|
||||
/cs61b/oop/inheritance/index.{html} /cs61b/oop/inheritance/
|
||||
/example//index.{html} /example//
|
||||
/features/section//index.{html} /features/section//
|
||||
/example/table-of-contents/with-toc/index.{html} /example/table-of-contents/with-toc/
|
||||
/configuration/hosting/index.{html} /configuration/hosting/
|
||||
/cs61b/abstract-data-types/collections/linked-lists/index.{html} /cs61b/abstract-data-types/collections/linked-lists/
|
||||
/cs61b/misc-topics/more-resources/index.{html} /cs61b/misc-topics/more-resources/
|
||||
/configuration/docker/index.{html} /configuration/docker/
|
||||
/cs61b/algorithms/searching/binary-search/index.{html} /cs61b/algorithms/searching/binary-search/
|
||||
/cs61b/oop/dynamic-method-selection/index.{html} /cs61b/oop/dynamic-method-selection/
|
||||
/cs61b/abstract-data-types/binary-trees/heaps/index.{html} /cs61b/abstract-data-types/binary-trees/heaps/
|
||||
/cs61b/algorithms/minimum-spanning-trees/kruskals-algorithm/index.{html} /cs61b/algorithms/minimum-spanning-trees/kruskals-algorithm/
|
||||
/cs61b/abstract-data-types/binary-trees/tries/index.{html} /cs61b/abstract-data-types/binary-trees/tries/
|
||||
/cs61b/abstract-data-types/graphs/index.{html} /cs61b/abstract-data-types/graphs/
|
||||
/setup//index.{html} /setup//
|
||||
/setup/obsidian/index.{html} /setup/obsidian/
|
||||
/cs61b/algorithms/searching/README/index.{html} /cs61b/algorithms/searching/README/
|
||||
/cs61b/algorithms/shortest-paths/a-search/index.{html} /cs61b/algorithms/shortest-paths/a-search/
|
||||
/cs61b/asymptotics/asymptotics/index.{html} /cs61b/asymptotics/asymptotics/
|
||||
/configuration/ignore-notes/index.{html} /configuration/ignore-notes/
|
||||
/configuration/obsidian/index.{html} /configuration/obsidian/
|
||||
/cs61b//index.{html} /cs61b//
|
||||
/cs61b/misc-topics/exceptions/index.{html} /cs61b/misc-topics/exceptions/
|
||||
/cs61b/sorting/sorting-basics/index.{html} /cs61b/sorting/sorting-basics/
|
||||
/features/latex/index.{html} /features/latex/
|
||||
/setup/hosting/index.{html} /setup/hosting/
|
||||
/setup/troubleshooting/index.{html} /setup/troubleshooting/
|
||||
/cs61b/abstract-data-types/collections/arrays/index.{html} /cs61b/abstract-data-types/collections/arrays/
|
||||
/cs61b/algorithms/searching/breadth-first-search-bfs/index.{html} /cs61b/algorithms/searching/breadth-first-search-bfs/
|
||||
/setup/config/index.{html} /setup/config/
|
||||
/cs61b/algorithms/searching/dijkstras/index.{html} /cs61b/algorithms/searching/dijkstras/
|
||||
/features/callouts/index.{html} /features/callouts/
|
||||
/cs61b/asymptotics/amortization/index.{html} /cs61b/asymptotics/amortization/
|
||||
/example/table-of-contents/without-toc/index.{html} /example/table-of-contents/without-toc/
|
||||
/features/tabs/index.{html} /features/tabs/
|
||||
/cs61b/algorithms/minimum-spanning-trees/prims-algorithm/index.{html} /cs61b/algorithms/minimum-spanning-trees/prims-algorithm/
|
||||
/features/columns/index.{html} /features/columns/
|
||||
/setup/editing/index.{html} /setup/editing/
|
||||
/cs61b//index.{html} /cs61b//
|
||||
/cs61b/abstract-data-types/collections/sets/index.{html} /cs61b/abstract-data-types/collections/sets/
|
||||
/features/languages/index.{html} /features/languages/
|
||||
/cs61b/algorithms/minimax/index.{html} /cs61b/algorithms/minimax/
|
||||
/cs61b/asymptotics/asymptotics-practice/index.{html} /cs61b/asymptotics/asymptotics-practice/
|
||||
/example/collapsed/3rd-level/4th-level/index.{html} /example/collapsed/3rd-level/4th-level/
|
||||
/setup/search/index.{html} /setup/search/
|
||||
/index.html /
|
||||
/cs61b/oop/objects/index.{html} /cs61b/oop/objects/
|
||||
/cs61b/abstract-data-types/hashing/index.{html} /cs61b/abstract-data-types/hashing/
|
||||
/features/expand/index.{html} /features/expand/
|
||||
/setup/custom-Domain/index.{html} /setup/custom-Domain/
|
||||
/setup/updating/index.{html} /setup/updating/
|
||||
/cs61b/SUMMARY/index.{html} /cs61b/SUMMARY/
|
||||
/cs61b/abstract-data-types/comparables-and-comparators/index.{html} /cs61b/abstract-data-types/comparables-and-comparators/
|
||||
/features//index.{html} /features//
|
||||
/features/section/second-page/index.{html} /features/section/second-page/
|
||||
/cs61b/abstract-data-types/collections/stacks-and-queues/index.{html} /cs61b/abstract-data-types/collections/stacks-and-queues/
|
||||
/cs61b/algorithms/searching/binary-search/index.{html} /cs61b/algorithms/searching/binary-search/
|
||||
/cs61b/misc-topics/exceptions/index.{html} /cs61b/misc-topics/exceptions/
|
||||
/cs61b/abstract-data-types/binary-trees/README/index.{html} /cs61b/abstract-data-types/binary-trees/README/
|
||||
/cs61b/abstract-data-types/binary-trees/heaps/index.{html} /cs61b/abstract-data-types/binary-trees/heaps/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user