diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 40b2d4a..b408270 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1 @@ -github: [jackyzha0] +github: [64bitpandas] diff --git a/README.md b/README.md index 02cad52..b8b837a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Amethyst Hugo Theme -[![Hugo](https://img.shields.io/badge/hugo-0.79-blue.svg)](https://gohugo.io) +[![Hugo](https://img.shields.io/badge/hugo-0.96-blue.svg)](https://gohugo.io) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](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) diff --git a/assets/_colors.scss b/assets/_colors.scss new file mode 100644 index 0000000..3ae80d9 --- /dev/null +++ b/assets/_colors.scss @@ -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; +} diff --git a/assets/_fonts.scss b/assets/_fonts.scss index 1e873a5..cb1d8fc 100644 --- a/assets/_fonts.scss +++ b/assets/_fonts.scss @@ -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 { diff --git a/assets/book.scss b/assets/book.scss index 3ca1238..715f513 100644 --- a/assets/book.scss +++ b/assets/book.scss @@ -12,5 +12,6 @@ @import "shortcodes"; // Custom defined styles +@import "colors"; @import "amethyst"; @import "custom"; diff --git a/assets/indices/contentIndex.json b/assets/indices/contentIndex.json index 843b45a..9c6d77f 100644 --- a/assets/indices/contentIndex.json +++ b/assets/indices/contentIndex.json @@ -1,86 +1,8 @@ { "/": { - "title": "πŸͺ΄ Quartz 3.", - "content": "\nHost your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features\n\n1. Extremely fast natural-language [[notes/search]]\n2. Customizable and hackable design based on [Hugo](https://gohugo.io/)\n3. Automatically generated backlinks, link previews, and local graph\n4. Built-in [[notes/CJK + Latex Support (ζ΅‹θ―•) | CJK + Latex Support]] and [[notes/callouts | Admonition-style callouts]]\n5. Support for both Markdown Links and Wikilinks\n\nCheck 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.\n\n## Get Started\n\u003e πŸ“š Step 1: [Setup your own digital garden using Quartz](notes/setup.md)\n\nReturning user? Figure out how to [[notes/updating|update]] your existing Quartz garden.\n\nIf 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).\n\n### Troubleshooting\n- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)\n- πŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)\n- πŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t)\n\n[[notes/foo]] [[notes/foo/footest]]", - "lastmodified": "2022-12-31T02:09:59.91496047Z", - "tags": null - }, - "/configuration/": { - "title": "", - "content": "", - "lastmodified": "2023-01-05T06:57:26.743516296Z", - "tags": null - }, - "/configuration/config": { - "title": "Configuration", - "content": "\n## Configuration\nQuartz 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.\n\nThe majority of configuration can be found under `data/config.yaml`. An annotated example configuration is shown below.\n\n```yaml {title=\"data/config.yaml\"}\n# The name to display in the footer\nname: Jacky Zhao\n\n# whether to globally show the table of contents on each page\n# this can be turned off on a per-page basis by adding this to the\n# front-matter of that note\nenableToc: true\n\n# whether to by-default open or close the table of contents on each page\nopenToc: false\n\n# whether to display on-hover link preview cards\nenableLinkPreview: true\n\n# whether to render titles for code blocks\nenableCodeBlockTitle: true \n\n# whether to render copy buttons for code blocks\nenableCodeBlockCopy: true \n\n# whether to render callouts\nenableCallouts: true\n\n# whether to try to process Latex\nenableLatex: true\n\n# whether to enable single-page-app style rendering\n# this prevents flashes of unstyled content and improves\n# smoothness of Quartz. More info in issue #109 on GitHub\nenableSPA: true\n\n# whether to render a footer\nenableFooter: true\n\n# whether backlinks of pages should show the context in which\n# they were mentioned\nenableContextualBacklinks: true\n\n# whether to show a section of recent notes on the home page\nenableRecentNotes: false\n\n# whether to display an 'edit' button next to the last edited field\n# that links to github\nenableGitHubEdit: true\nGitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content\n\n# whether to render mermaid diagrams\nenableMermaid: true\n\n# whether to use Operand to power semantic search\n# IMPORTANT: replace this API key with your own if you plan on using\n# Operand search!\nsearch:\n enableSemanticSearch: false\n operandApiKey: \"REPLACE-WITH-YOUR-OPERAND-API-KEY\"\n operandIndexId: \"REPLACE-WITH-YOUR-OPERAND-INDEX-ID\"\n\n# page description used for SEO\ndescription:\n Host your second brain and digital garden for free. Quartz features extremely fast full-text search,\n Wikilink support, backlinks, local graph, tags, and link previews.\n\n# title of the home page (also for SEO)\npage_title:\n \"πŸͺ΄ Quartz 3.3\"\n\n# links to show in the footer\nlinks:\n - link_name: Twitter\n link: https://twitter.com/_jzhao\n - link_name: Github\n link: https://github.com/jackyzha0\n```\n\n### Code Block Titles\nTo add code block titles with Quartz:\n\n1. Ensure that code block titles are enabled in Quartz's configuration:\n\n ```yaml {title=\"data/config.yaml\", linenos=false}\n enableCodeBlockTitle: true\n ```\n\n2. Add the `title` attribute to the desired [code block\n fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):\n\n ```markdown {linenos=false}\n ```yaml {title=\"data/config.yaml\"}\n enableCodeBlockTitle: true # example from step 1\n ```\n ```\n\n**Note** that if `{title=\u003cmy-title\u003e}` is included, and code block titles are not\nenabled, no errors will occur, and the title attribute will be ignored.\n\n### HTML Favicons\nIf you would like to customize the favicons of your Quartz-based website, you \ncan add them to the `data/config.yaml` file. The **default** without any set \n`favicon` key is:\n\n```html {title=\"layouts/partials/head.html\", linenostart=15}\n\u003clink rel=\"shortcut icon\" href=\"icon.png\" type=\"image/png\"\u003e\n```\n\nThe default can be overridden by defining a value to the `favicon` key in your \n`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is\nequivalent to the default:\n\n```yaml {title=\"data/config.yaml\", linenos=false}\nfavicon:\n - { rel: \"shortcut icon\", href: \"icon.png\", type: \"image/png\" }\n# - { ... } # Repeat for each additional favicon you want to add\n```\n\nIn this format, the keys are identical to their HTML representations.\n\nIf you plan to add multiple favicons generated by a website (see list below), it\nmay be easier to define it as HTML. Here is an example which appends the \n**Apple touch icon** to Quartz's default favicon:\n\n```yaml {title=\"data/config.yaml\", linenos=false}\nfavicon: |\n \u003clink rel=\"shortcut icon\" href=\"icon.png\" type=\"image/png\"\u003e\n \u003clink rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"/apple-touch-icon.png\"\u003e\n```\n\nThis second favicon will now be used as a web page icon when someone adds your \nwebpage to the home screen of their Apple device. If you are interested in more \ninformation about the current and past standards of favicons, you can read \n[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).\n\n**Note** that all generated favicon paths, defined by the `href` \nattribute, are relative to the `static/` directory.\n\n### Graph View\nTo customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.\n\n```yaml {title=\"data/graphConfig.yaml\"}\n# if true, a Global Graph will be shown on home page with full width, no backlink.\n# A different set of Local Graphs will be shown on sub pages.\n# if false, Local Graph will be default on every page as usual\nenableGlobalGraph: false\n\n### Local Graph ###\nlocalGraph:\n # whether automatically generate a legend\n enableLegend: false\n \n # whether to allow dragging nodes in the graph\n enableDrag: true\n \n # whether to allow zooming and panning the graph\n enableZoom: true\n \n # how many neighbours of the current node to show (-1 is all nodes)\n depth: 1\n \n # initial zoom factor of the graph\n scale: 1.2\n \n # how strongly nodes should repel each other\n repelForce: 2\n\n # how strongly should nodes be attracted to the center of gravity\n centerForce: 1\n\n # what the default link length should be\n linkDistance: 1\n \n # how big the node labels should be\n fontSize: 0.6\n \n # scale at which to start fading the labes on nodes\n opacityScale: 3\n\n### Global Graph ###\nglobalGraph:\n\t# same settings as above\n\n### For all graphs ###\n# colour specific nodes path off of their path\npaths:\n - /moc: \"#4388cc\"\n```\n\n\n## Styling\nWant 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`. \n\n### Partials\nPartials 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`.\n\nFor 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`\n\nMore info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)\n\nStill having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n\n## Language Support\n[CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) comes out of the box with Quartz.\n\nWant to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.\n\nFollow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml`\n\nFor example:\n\n```toml\ndefaultContentLanguage = 'ar'\n[languages]\n [languages.ar]\n languagedirection = 'rtl'\n title = 'Ω…Ψ―ΩˆΩ†Ψͺي'\n weight = 1\n```\n", - "lastmodified": "2022-12-31T02:53:43.344377399Z", - "tags": null - }, - "/configuration/custom-Domain": { - "title": "Custom Domain", - "content": "\n### Registrar\nThis step is only applicable if you are using a **custom domain**! If you are using a `\u003cYOUR-USERNAME\u003e.github.io` domain, you can skip this step.\n\nFor this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).\n\nGitHub 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\n\n1. Go to your forked repository (`github.com/\u003cYOUR-GITHUB-USERNAME\u003e/quartz`) settings page and go to the Pages tab. Under \"Custom domain\", type your custom domain, then click **Save**.\n2. Go to your DNS Provider and create a CNAME record that points from your domain to `\u003cYOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).\n\n\t![Example Configuration for Quartz](/notes/images/google-domains.png)*Example Configuration for Quartz*\n3. Wait 30 minutes to an hour for the network changes to kick in.\n4. Done!", - "lastmodified": "2022-12-31T02:53:43.344377399Z", - "tags": null - }, - "/configuration/docker": { - "title": "Hosting with Docker", - "content": "\nIf 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).\n## Hosting Quartz Locally\nYou can serve Quartz locally at `http://localhost:1313` with the following script, replacing `/path/to/quartz` with the \nactual path to your Quartz folder.\n\ndocker-compose.yml\n```\nservices:\n quartz-hugo:\n image: ghcr.io/jackyzha0/quartz:hugo\n container_name: quartz-hugo\n volumes:\n - /path/to/quartz:/quartz\n ports:\n - 1313:1313\n\n # optional\n environment:\n - HUGO_BIND=0.0.0.0\n - HUGO_BASEURL=http://localhost\n - HUGO_PORT=1313\n - HUGO_APPENDPORT=true\n```\n\nThen run with: `docker-compose up -d` in the same directory as your `docker-compose.yml` file.\n\nWhile the container is running, you can update the `quartz` fork with: `docker exec -it quartz-hugo make update`.\n\n## Exposing Your Container to the Internet\n\n### To Your Public IP Address with Port Forwarding (insecure)\n\nAssuming 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):\n\n1. You should set the environment variable `HUGO_BASEURL=http://your-public-ip` and then start your container.\n2. Set up port forwarding on your router from port `p` to `your-local-ip:1313`.\n3. You should now be able to access Quartz from outside your local network at `http://your-public-ip:p`.\n\nHowever, your HTTP connection will be unencrypted and **this method is not secure**.\n\n### To a Domain using Cloudflare Proxy\n\n1. Port forward 443 (HTTPS) from your machine.\n2. 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.\n3. 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`.\n4. Spin up your Quartz container and enjoy it at `https://your-domain.com`!\n\n### To a Domain using a Reverse Proxy\n\nIf 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!\n", - "lastmodified": "2022-12-31T02:53:43.344377399Z", - "tags": null - }, - "/configuration/editing": { - "title": "Editing Content in Quartz", - "content": "\n## Editing \nQuartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).\n\n### Folder Structure\nHere's a rough overview of what's what.\n\n**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.\n\n**To edit the main home page, open `/content/_index.md`.**\n\nTo 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**. \n\n```markdown\nFor example, I want to link this current document to `notes/config.md`.\n[A link to the config page](notes/config.md)\n```\n\nSimilarly, you can put local images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\nYou can also use wikilinks if that is what you are more comfortable with!\n\n### Front Matter\nHugo 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.\n\n```yaml\n---\ntitle: \"Example Title\"\ntags:\n- example-tag\n---\n\nRest of your content here...\n```\n\n### Obsidian\nI 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.\n\nThis step is **highly recommended**.\n\n\u003e πŸ”— Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)\n\n## Previewing Changes\nThis 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.\n\n\u003e πŸ‘€ Step 4: [Preview Quartz Changes](notes/preview%20changes.md)\n\nFor those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.\n\n## Publishing Changes\nNow that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!\n\n\u003e 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n", - "lastmodified": "2022-12-31T02:53:43.344377399Z", - "tags": null - }, - "/configuration/hosting": { - "title": "Deploying Quartz to the Web", - "content": "\n## Hosting on GitHub Pages\nQuartz 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.\n\n### Enable GitHub Actions\nBy 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!\n\n![Enable GitHub Actions](notes/images/github-actions.png)*Enable GitHub Actions*\n\n### Enable GitHub Pages\n\nHead to the 'Settings' tab of your forked repository and go to the 'Pages' tab.\n\n1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`\n2. Set a custom domain here if you have one!\n\n![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages*\n\n### Pushing Changes\nTo 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.\n\n```shell\n# Navigate to Quartz folder\ncd \u003cpath-to-quartz\u003e\n\n# Commit all changes\ngit add .\ngit commit -m \"message describing changes\"\n\n# Push to GitHub to update site\ngit push origin hugo\n```\n\nNote: 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.\n\n### Setting up the Site\nNow 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.\n\nHere, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. \n\nMake sure that your `baseURL` has a trailing `/`!\n\n[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)\n\n```toml\nbaseURL = \"https://\u003cYOUR-DOMAIN\u003e/\"\n```\n\nIf you are using this under a subdomain (e.g. `\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!**\n\n```toml\nbaseURL = \"https://\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz/\"\n```\n\nChange `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `\u003cYOUR-USERNAME\u003e.github.io`.\n\nPlease note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.\n\n[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)\n\n```yaml {title=\".github/workflows/deploy.yaml\"}\n- name: Deploy \n uses: peaceiris/actions-gh-pages@v3 \n with: \n\tgithub_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!\n\tpublish_dir: ./public \n\tpublish_branch: master\n\tcname: \u003cYOUR-DOMAIN\u003e\n```\n\nHave a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).\n\n### Ignoring Files\nOnly want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.\n\n❌ [Excluding pages from being published](notes/ignore%20notes.md)\n\n## Docker Support\nIf you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead!\nI would *not use this method* unless you know what you are doing.\n\n---\n\nNow that your Quartz is live, let's figure out how to make Quartz really *yours*!\n\n\u003e Step 6: 🎨 [Customizing Quartz](notes/config.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n", - "lastmodified": "2023-01-01T23:44:35.436929149Z", - "tags": null - }, - "/configuration/ignore-notes": { - "title": "Ignoring Notes", - "content": "\n### Quartz Ignore\nEdit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered.\n\n```toml\n...\nignoreFiles = [ \n \"/content/templates/*\", \n \"/content/private/*\", \n \"\u003cyour path here\u003e\"\n]\n```\n\n`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\\\.png$`).\nTo ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note.\n\n```markdown\n---\ntitle: Some Private Note\ndraft: true\n---\n...\n```\n\nMore details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering).\n\n### Global Ignore\nHowever, 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.", - "lastmodified": "2022-12-31T02:53:43.344377399Z", - "tags": null - }, - "/configuration/obsidian": { - "title": "Obsidian Vault Integration", - "content": "\n## Setup\nObsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.\n\n### New Vault\nIf 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.\n\n### Linking an existing Vault\nThe easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.\n\n## Settings\nGreat, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.\n\n1. Under Options \u003e Files and Links, set the New link format to always use Absolute Path in Vault.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n\n![Obsidian Settings](/notes/images/obsidian-settings.png)*Obsidian Settings*\n\n## Templates\nInserting 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.\n\n**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**\n\nHead over to Options \u003e Core Plugins and enable the Templates plugin. Then go to Options \u003e 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!\n\n\u003e πŸ‘€ Step 4: [Preview Quartz Changes](notes/preview%20changes.md)", - "lastmodified": "2022-12-31T02:53:43.348377376Z", - "tags": null - }, - "/configuration/preview-changes": { - "title": "Preview Changes", - "content": "\nIf you'd like to preview what your Quartz site looks like before deploying it to the internet, the following\ninstructions guide you through installing the proper dependencies to run it locally.\n\n\n## Install `hugo-obsidian`\nThis step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (\u003e= 1.16) installed.\n\n```bash\n# Install and link `hugo-obsidian` locally\ngo install github.com/jackyzha0/hugo-obsidian@latest\n```\n\nIf you are running into an error saying that `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.\n\nAfterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!\n\n## Installing Hugo\nHugo is the static site generator that powers Quartz. [Install Hugo with \"extended\" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,\n\n```bash\n# Navigate to your local Quartz folder\ncd \u003clocation-of-your-local-quartz\u003e\n\n# Start local server\nmake serve\n\n# View your site in a browser at http://localhost:1313/\n```\n\n\u003e [!INFO] Docker Support\n\u003e\n\u003e If you have Docker installed already, open your terminal, navigate to your folder with Quartz and run `make docker`\n\nNow that you are happy with how your Quartz instance looks, let's get it hosted!\n\n\u003e 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)\n", - "lastmodified": "2022-12-31T02:53:43.348377376Z", - "tags": null - }, - "/configuration/search": { - "title": "Search", - "content": "\nQuartz supports two modes of searching through content.\n\n## Full-text\nFull-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.\n\n```yaml {title=\"data/config.yaml\"}\n# the default option\nenableSemanticSearch: false\n```\n\n## Natural Language\nNatural language search is powered by [Operand](https://beta.operand.ai/). It understands language like a person does and finds results that best match user intent. In this sense, it is closer to how Google Search works.\n\nNatural language search tends to produce higher quality results than full-text search.\n\nHere's how to set it up.\n\n1. 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.\n2. 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`.\n3. Click into the index you've created. Under \"Index Something\", select \"SITEMAP\" from the dropdown and click \"Add Source\".\n4. 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. \n5. 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.\n6. 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..\n\n```yaml {title=\"data/config.yaml\"}\n# the default option\nsearch:\n enableSemanticSearch: true\n operandApiKey: \"jp9k5hudse2a828z98kxd6z3payi8u90rnjf\"\n operandIndexId: \"s0kf3bd6tldw\"\n```\n7. Push your changes to the site and wait for it to deploy.\n8. Check the Operand dashboard and wait for your site to index. Enjoy natural language search powered by Operand!\n", - "lastmodified": "2022-12-31T02:53:43.348377376Z", - "tags": null - }, - "/configuration/setup": { - "title": "Setup", - "content": "\n## Making your own Quartz\nSetting 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!\n\n### Forking\n\u003e A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.\n\nNavigate to the GitHub repository for the Quartz project:\n\nπŸ“ [Quartz Repository](https://github.com/jackyzha0/quartz)\n\nThen, 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).\n\n### Cloning\nAfter 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.\n\n```shell\ngit clone https://github.com/YOUR-USERNAME/quartz\n```\n\n## Editing\nGreat! 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.\n\n\u003e ✏️ Step 2: [Editing Notes in Quartz](notes/editing.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n", - "lastmodified": "2022-12-31T02:53:43.348377376Z", - "tags": null - }, - "/configuration/troubleshooting": { - "title": "Troubleshooting and FAQ", - "content": "\nStill having trouble? Here are a list of common questions and problems people encounter when installing Quartz.\n\nWhile you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)\n\n### Does Quartz have Latex support?\nYes! See [CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) for a brief demo.\n\n### Can I use \\\u003cObsidian Plugin\\\u003e in Quartz?\nUnless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.\n\nThe easiest way would be to add your own HTML partial that supports the functionality you are looking for.\n\n### My GitHub pages is just showing the README and not Quartz\nMake sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide\n\n### Some of my pages have 'January 1, 0001' as the last modified date\nThis 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.\n\n```shell\n# in the root of your Quartz (same folder as config.toml)\ngit config core.ignorecase true\n\n# or globally (not recommended)\ngit config --global core.ignorecase true\n```\n\n### Can I publish only a subset of my pages?\nYes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore%20notes.md).\n\n### Can I host this myself and not on GitHub Pages?\nYes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).\n\n### `command not found: hugo-obsidian`\nMake sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.\n\n```shell\n# Add the following 2 lines to your ~/.bash_profile\nexport GOPATH=/Users/$USER/go\nexport PATH=$GOPATH/bin:$PATH\n\n# In your current terminal, to reload the session\nsource ~/.bash_profile\n```\n\n### How come my notes aren't being rendered?\nYou 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).\n\n### My custom domain isn't working!\nWalk 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.\n\n### How do I setup Google Analytics?\nYou can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.\n\n### How do I change the content on the home page?\nTo edit the main home page, open `/content/_index.md`.\n\n### How do I change the colours?\nYou 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).\n\n### How do I add images?\nYou can put images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\n### My Interactive Graph and Backlinks aren't up to date\nBy 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)\n\n### Can I use React/Vue/some other framework?\nNot 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.\n\n## Still Stuck?\nQuartz 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.\n\nπŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)", - "lastmodified": "2022-12-31T02:53:43.348377376Z", - "tags": null - }, - "/configuration/updating": { - "title": "Updating", - "content": "\nHaven'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! \n\n```shell\nmake update\n```\n\nOr, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!)\n\n```shell\nmake update-force\n```\n\nOr, manually checkout the changes yourself.\n\n\u003e [!warning] Warning!\n\u003e\n\u003e If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!\n\u003e Make sure you have a copy of these changes if you don't want to lose them.\n\n\n```shell\n# add Quartz as a remote host\ngit remote add upstream git@github.com:jackyzha0/quartz.git\n\n# index and fetch changes\ngit fetch upstream\ngit checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data \n```\n", - "lastmodified": "2022-12-31T02:53:43.348377376Z", + "title": "πŸ’œ Welcome to Amethyst!", + "content": "\n## What is Amethyst?\nAmethyst 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).\n\nThe 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://jzhao.xyz/posts/networked-thought)\n\n\nHost your second brain and for free. Quartz features\n\n1. Extremely fast natural-language [[notes/search]]\n2. Customizable and hackable design based on [Hugo](https://gohugo.io/)\n3. Automatically generated backlinks, link previews, and local graph\n4. Built-in [[notes/CJK + Latex Support (ζ΅‹θ―•) | CJK + Latex Support]] and [[notes/callouts | Admonition-style callouts]]\n5. Support for both Markdown Links and Wikilinks\n\nCheck 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.\n\n## Get Started\n\u003e πŸ“š Step 1: [Setup your own digital garden using Quartz](notes/setup.md)\n\nReturning user? Figure out how to [[notes/updating|update]] your existing Quartz garden.\n\nIf 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).\n\n### Troubleshooting\n- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)\n- πŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)\n- πŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t)\n\n[[notes/foo]] [[notes/foo/footest]]", + "lastmodified": "2023-01-05T20:57:35.346631289Z", "tags": null }, "/cs61b/": { @@ -379,8 +301,8 @@ }, "/features/callouts": { "title": "Callouts", - "content": "\n## Callout support\n\nQuartz supports the same Admonition-callout syntax as Obsidian.\n\nThis includes\n- 12 Distinct callout types (each with several aliases)\n- Collapsable callouts\n\nSee [documentation on supported types and syntax here](https://help.obsidian.md/How+to/Use+callouts#Types).\n\n## Showcase\n\n\u003e [!EXAMPLE] Examples\n\u003e\n\u003e Aliases: example\n\n\u003e [!note] Notes\n\u003e\n\u003e Aliases: note\n\n\u003e [!abstract] Summaries \n\u003e\n\u003e Aliases: abstract, summary, tldr\n\n\u003e [!info] Info \n\u003e\n\u003e Aliases: info, todo\n\n\u003e [!tip] Hint \n\u003e\n\u003e Aliases: tip, hint, important\n\n\u003e [!success] Success \n\u003e\n\u003e Aliases: success, check, done\n\n\u003e [!question] Question \n\u003e\n\u003e Aliases: question, help, faq\n\n\u003e [!warning] Warning \n\u003e\n\u003e Aliases: warning, caution, attention\n\n\u003e [!failure] Failure \n\u003e\n\u003e Aliases: failure, fail, missing\n\n\u003e [!danger] Error\n\u003e\n\u003e Aliases: danger, error\n\n\u003e [!bug] Bug\n\u003e\n\u003e Aliases: bug\n\n\u003e [!quote] Quote\n\u003e\n\u003e Aliases: quote, cite\n", - "lastmodified": "2023-01-05T06:51:06.171364064Z", + "content": "\n## Callout support\n\nAmethyst supports the same Admonition-callout syntax as Obsidian.\n\nThis includes\n- 12 Distinct callout types (each with several aliases)\n- Collapsable callouts\n\nSee [documentation on supported types and syntax here](https://help.obsidian.md/How+to/Use+callouts#Types).\n\n## Showcase\n\n\u003e [!EXAMPLE] Examples\n\u003e\n\u003e Aliases: example\n\n\u003e [!note] Notes\n\u003e\n\u003e Aliases: note\n\n\u003e [!abstract] Summaries \n\u003e\n\u003e Aliases: abstract, summary, tldr\n\n\u003e [!info] Info \n\u003e\n\u003e Aliases: info, todo\n\n\u003e [!tip] Hint \n\u003e\n\u003e Aliases: tip, hint, important\n\n\u003e [!success] Success \n\u003e\n\u003e Aliases: success, check, done\n\n\u003e [!question] Question \n\u003e\n\u003e Aliases: question, help, faq\n\n\u003e [!warning] Warning \n\u003e\n\u003e Aliases: warning, caution, attention\n\n\u003e [!failure] Failure \n\u003e\n\u003e Aliases: failure, fail, missing\n\n\u003e [!danger] Error\n\u003e\n\u003e Aliases: danger, error\n\n\u003e [!bug] Bug\n\u003e\n\u003e Aliases: bug\n\n\u003e [!quote] Quote\n\u003e\n\u003e Aliases: quote, cite\n", + "lastmodified": "2023-01-05T20:50:35.878992838Z", "tags": null }, "/features/columns": { @@ -403,8 +325,8 @@ }, "/features/languages": { "title": "Chinese, Japanese, Korean Support (ζ΅‹θ―•)", - "content": "\n## Chinese, Japanese, Korean Support\nε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚\n\nμš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.\n\nη§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚\n\n## RTL\nMore information on configuring RTL languages like Arabic in the [config](notes/config.md) page.\n", - "lastmodified": "2023-01-05T06:49:42.120137696Z", + "content": "\n## Chinese, Japanese, Korean Support\nε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚\n\nμš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.\n\nη§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚\n\n## RTL\nMore information on configuring RTL languages like Arabic in the [config](setup/config.md) page.\n", + "lastmodified": "2023-01-05T07:07:59.452468939Z", "tags": null }, "/features/latex": { @@ -442,5 +364,77 @@ "content": "# Tabs\n\nTabs let you organize content by context, for example installation instructions for each supported platform.\n\n```tpl\n{{\u003c/* tabs \"uniqueid\" */\u003e}}\n{{\u003c/* tab \"MacOS\" */\u003e}} # MacOS Content {{\u003c/* /tab */\u003e}}\n{{\u003c/* tab \"Linux\" */\u003e}} # Linux Content {{\u003c/* /tab */\u003e}}\n{{\u003c/* tab \"Windows\" */\u003e}} # Windows Content {{\u003c/* /tab */\u003e}}\n{{\u003c/* /tabs */\u003e}}\n```\n\n## Example\n\n{{\u003c tabs \"uniqueid\" \u003e}}\n{{\u003c tab \"MacOS\" \u003e}}\n# MacOS\n\nThis is tab **MacOS** content.\n\nLorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat\nstringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa\nprotulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.\nMiseratus fonte Ditis conubia.\n{{\u003c /tab \u003e}}\n\n{{\u003c tab \"Linux\" \u003e}}\n\n# Linux\n\nThis is tab **Linux** content.\n\nLorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat\nstringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa\nprotulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.\nMiseratus fonte Ditis conubia.\n{{\u003c /tab \u003e}}\n\n{{\u003c tab \"Windows\" \u003e}}\n\n# Windows\n\nThis is tab **Windows** content.\n\nLorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat\nstringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa\nprotulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.\nMiseratus fonte Ditis conubia.\n{{\u003c /tab \u003e}}\n{{\u003c /tabs \u003e}}\n", "lastmodified": "2023-01-05T06:31:25.83529555Z", "tags": null + }, + "/setup/": { + "title": "", + "content": "", + "lastmodified": "2023-01-05T07:00:05.641797687Z", + "tags": null + }, + "/setup/config": { + "title": "Customization", + "content": "\n# Configuration\nAmethyst 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.\n\nThe 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).\n\n### Code Block Titles\nTo add code block titles with Amethyst:\n\n1. Ensure that code block titles are enabled in the configuration:\n\n ```yaml {title=\"data/config.yaml\", linenos=false}\n enableCodeBlockTitle: true\n ```\n\n2. Add the `title` attribute to the desired [code block\n fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):\n\n ```markdown {linenos=false}\n ```yaml {title=\"data/config.yaml\"}\n enableCodeBlockTitle: true # example from step 1\n ```\n ```\n\n**Note** that if `{title=\u003cmy-title\u003e}` is included, and code block titles are not\nenabled, no errors will occur, and the title attribute will be ignored.\n\n### HTML Favicons\nIf you would like to customize the favicons, you \ncan add them to the `data/config.yaml` file. The **default** without any set \n`favicon` key is:\n\n```html {title=\"layouts/partials/head.html\", linenostart=15}\n\u003clink rel=\"shortcut icon\" href=\"icon.png\" type=\"image/png\"\u003e\n```\n\nThe default can be overridden by defining a value to the `favicon` key in your \n`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is\nequivalent to the default:\n\n```yaml {title=\"data/config.yaml\", linenos=false}\nfavicon:\n - { rel: \"shortcut icon\", href: \"icon.png\", type: \"image/png\" }\n# - { ... } # Repeat for each additional favicon you want to add\n```\n\nIn this format, the keys are identical to their HTML representations.\n\nIf you plan to add multiple favicons generated by a website (see list below), it\nmay be easier to define it as HTML. Here is an example which appends the \n**Apple touch icon** to Amethyst's default favicon:\n\n```yaml {title=\"data/config.yaml\", linenos=false}\nfavicon: |\n \u003clink rel=\"shortcut icon\" href=\"icon.png\" type=\"image/png\"\u003e\n \u003clink rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"/apple-touch-icon.png\"\u003e\n```\n\nThis second favicon will now be used as a web page icon when someone adds your \nwebpage to the home screen of their Apple device. If you are interested in more \ninformation about the current and past standards of favicons, you can read \n[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).\n\n**Note** that all generated favicon paths, defined by the `href` \nattribute, are relative to the `static/` directory.\n\n### Graph View\nTo 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).\n\n### Language Support\n[Chinese, Japanese, and Korean support](features/language.md) comes out of the box with Amethyst.\n\nWant to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Amethyst) supports this natively.\n\nFollow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.yaml`\n\nFor example:\n\n```yaml\ndefaultContentLanguage: ar\nlanguages:\n ar:\n languagedirection: rtl\n title: Ω…Ψ―ΩˆΩ†Ψͺي\n weight: 2\n```\n\n# Custom Styles\nWant 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`. \n\n### Changing the Color Scheme\nThe 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`.\n\n### Changing the Fonts\nAll 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).\n\nYou can place all local fonts in the `static/fonts` folder.\n\n### Partials\nPartials 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`.\n\nFor 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`\n\nMore info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)\n\nStill having problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).\n\n\n", + "lastmodified": "2023-01-05T20:27:26.526242587Z", + "tags": null + }, + "/setup/custom-Domain": { + "title": "Custom Domain", + "content": "\n### Registrar\nThis step is only applicable if you are using a **custom domain**! If you are using a `\u003cYOUR-USERNAME\u003e.github.io` domain, you can skip this step.\n\nFor this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).\n\nGitHub 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\n\n1. Go to your forked repository (`github.com/\u003cYOUR-GITHUB-USERNAME\u003e/amethyst`) settings page and go to the Pages tab. Under \"Custom domain\", type your custom domain, then click **Save**.\n2. Go to your DNS Provider and create a CNAME record that points from your domain to `\u003cYOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).\n\n\t![Example Configuration for Quartz](/setup/images/google-domains.png)*Example Configuration for Quartz*\n3. Wait 30 minutes to an hour for the network changes to kick in.\n4. Done!", + "lastmodified": "2023-01-05T20:49:06.807929818Z", + "tags": null + }, + "/setup/editing": { + "title": "Editing Content", + "content": "\n## Editing \nAmethyst runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).\n\n### Folder Structure\nHere's a rough overview of what's what.\n\n**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.\n\n**To edit the main home page, open `/content/_index.md`.**\n\nTo 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**. \n\n```markdown\nFor example, I want to link this current document to `setup/config.md`.\n[A link to the config page](setup/config.md)\n```\n\nSimilarly, you can put local images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/setup/images/example.png)\n![Example Image](/content/setup/images/example.png)\n```\n\nYou can also use wikilinks if that is what you are more comfortable with!\n\n### Front Matter\nHugo 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.\n\n```yaml\n---\ntitle: \"Example Title\"\ntags:\n- example-tag\n---\n\nRest of your content here...\n```\n\nYou can specify additional params in the front matter of individual pages:\n\n```toml\n# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'\ntype = 'docs'\n\n# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)\nweight = 10\n\n# (Optional) Set to 'true' to mark page as flat section in file-tree menu (if BookMenuBundle not set)\nbookFlatSection = false\n\n# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode\nbookCollapseSection = true\n\n# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set)\nbookHidden = false\n\n# (Optional) Set 'false' to hide ToC from page\nbookToC = true\n\n# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages.\nbookComments = true\n\n# (Optional) Set to 'false' to exclude page from search index.\nbookSearchExclude = true\n\n# (Optional) Set explicit href attribute for this page in a menu (if BookMenuBundle not set)\nbookHref = ''\n```\n\n\n### Obsidian\nAmethyst is built especially for use with [Obsidian](http://obsidian.md/) as a text editor. \n\nSee below for more information:\n\n\u003e πŸ”— Step 3: [How to setup your Obsidian Vault to work with Amethyst](setup/obsidian.md)\n\n## Previewing Changes\nThis 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.\n\n\u003e πŸ‘€ Step 4: [Preview Changes](setup/preview%20changes.md)\n\nFor those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.\n\n## Publishing Changes\nAfter you've finished editing your notes, you can publish them to the internet!\n\n\u003e 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)\n\nHaving problems? Check out our [FAQ and Troubleshooting guide](setup/troubleshooting.md).\n", + "lastmodified": "2023-01-05T20:35:30.496683846Z", + "tags": null + }, + "/setup/hosting": { + "title": "Deploying Amethyst to the Web", + "content": "\n## Hosting on GitHub Pages\nAmethyst 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.\n\n### Enable GitHub Actions\nBy 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!\n\n![Enable GitHub Actions](/setup/images/github-actions.png)*Enable GitHub Actions*\n\n### Enable GitHub Pages\n\nHead to the 'Settings' tab of your forked repository and go to the 'Pages' tab.\n\n1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`\n2. Set a custom domain here if you have one!\n\n![Enable GitHub Pages](/setup/images/github-pages.png)*Enable GitHub Pages*\n\n### Pushing Changes\nTo 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.\n\n```shell\n# Navigate to Amethyst folder\ncd \u003cpath-to-amethyst\u003e\n\n# Commit all changes\ngit add .\ngit commit -m \"message describing changes\"\n\n# Push to GitHub to update site\ngit push origin main\n```\n\nNote: 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.\n\n### Setting up the Site\nNow 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.\n\n\u003e 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.\n\nHere, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. \n\nMake sure that your `baseURL` has a trailing `/`!\n\n[Reference `config.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/config.yaml)\n\n```yaml\nbaseURL: \"https://\u003cYOUR-DOMAIN\u003e/\"\n```\n\nIf you are using this under a subdomain (e.g. `\u003cYOUR-GITHUB-USERNAME\u003e.github.io/amethyst/`), include the trailing `/`. **You need to do this especially if you are using GitHub!**\n\n```yaml\nbaseURL: \"https://\u003cYOUR-GITHUB-USERNAME\u003e.github.io/amethyst/\"\n```\n\nChange `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `\u003cYOUR-USERNAME\u003e.github.io`.\n\nPlease note that the `cname` field should *not* have any path `e.g. end with /amethyst` or have a trailing `/`.\n\n[Reference `deploy.yaml` here](https://github.com/64bitpandas/amethyst/blob/main/.github/workflows/deploy.yaml)\n\n```yaml {title=\".github/workflows/deploy.yaml\"}\n- name: Deploy \n uses: peaceiris/actions-gh-pages@v3 \n with: \n\tgithub_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!\n\tpublish_dir: ./public \n\tpublish_branch: deploy\n\tcname: \u003cYOUR-DOMAIN\u003e\n```\n\nHave a custom domain? [Learn how to set it up with Amethyst ](setup/custom%20Domain.md).\n\n### Ignoring Files\nOnly want to publish a subset of all of your notes? Don't worry, Amethyst makes this a simple two-step process.\n\n❌ [Excluding pages from being published](setup/ignore%20notes.md)\n\n---\n\nNow that your site is live, let's figure out how to make Amethyst really *yours*!\n\n\u003e Step 6: 🎨 [Customizing Amethyst](setup/config.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).\n", + "lastmodified": "2023-01-05T20:47:32.15292783Z", + "tags": null + }, + "/setup/ignore-notes": { + "title": "Ignoring Notes", + "content": "\nEdit `ignoreFiles` in `config.yaml` to include paths you'd like to exclude from being rendered.\n\n```toml\n...\nignoreFiles: [ \n \"/content/templates/*\", \n \"/content/private/*\", \n \"\u003cyour path here\u003e\"\n]\n```\n\n`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\\\.png$`).\nTo ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note.\n\n```markdown\n---\ntitle: Some Private Note\ndraft: true\n---\n...\n```\n\nMore details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering).\n\n### Global Ignore\nHowever, 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.", + "lastmodified": "2023-01-05T20:49:37.047611498Z", + "tags": null + }, + "/setup/obsidian": { + "title": "Obsidian Vault Integration", + "content": "\n## Setup\nObsidian is the preferred way to use Amethyst. You can either create a new Obsidian Vault or link one that your already have.\n\n### New Vault\nIf 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.\n\n### Linking an existing Vault (simple)\nThe easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.\n\n### Linking an existing Vault (using git)\nIf 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.\n\nThen, in both your vault and in Amethyst, run the following command, replacing the link with one to your new repository:\n```bash\ngit submodule add https://github.com/\u003cYOUR_USERNAME\u003e/\u003cREPO_NAME\u003e content\n```\n\n## Settings\nNow that you've added your notes to Amethyst, let's fix some settings so that they play well.\n\n1. Under Options \u003e Files and Links, set the New link format to always use Absolute Path in Vault.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n\n![Obsidian Settings](/setup/images/obsidian-settings.png)*Obsidian Settings*\n\n## Templates\nInserting 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.\n\n**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**\n\nHead over to Options \u003e Core Plugins and enable the Templates plugin. Then go to Options \u003e 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!\n\n\u003e πŸ‘€ Step 4: [Preview Changes](setup/preview%20changes.md)", + "lastmodified": "2023-01-05T20:45:54.033965179Z", + "tags": null + }, + "/setup/preview-changes": { + "title": "Preview Changes", + "content": "\nIf you'd like to preview what your site looks like before deploying it to the internet, the following\ninstructions guide you through installing the proper dependencies to run it locally.\n\n\n## Install `hugo-obsidian`\nThis step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (\u003e= 1.16) installed.\n\n```bash\n# Install and link `hugo-obsidian` locally\ngo install github.com/jackyzha0/hugo-obsidian@latest\n```\n\nIf you are running into an error saying that `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.\n\nAfterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!\n\n## Installing Hugo\nHugo is the static site generator that powers Amethyst. [Install Hugo with \"extended\" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,\n\n```bash\n# Navigate to your local Amethyst folder\ncd \u003clocation-of-your-local-amethyst\u003e\n\n# Start local server\nmake serve\n\n# View your site in a browser at http://localhost:1313/\n```\n\nNow that you are happy with how your Amethyst instance looks, let's get it hosted!\n\n\u003e 🌍 Step 5: [Hosting Amethyst online!](setup/hosting.md)\n", + "lastmodified": "2023-01-05T20:47:19.829057952Z", + "tags": null + }, + "/setup/search": { + "title": "Search", + "content": "\nAmethyst supports two modes of searching through content.\n\n## Full-text\nFull-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.\n\n```yaml {title=\"data/config.yaml\"}\n# the default option\nenableSemanticSearch: false\n```\n\n## Natural Language\nNatural language search is powered by [Operand](https://beta.operand.ai/). It understands language like a person does and finds results that best match user intent. In this sense, it is closer to how Google Search works.\n\nNatural language search tends to produce higher quality results than full-text search.\n\nHere's how to set it up.\n\n1. 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.\n2. 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`.\n3. Click into the index you've created. Under \"Index Something\", select \"SITEMAP\" from the dropdown and click \"Add Source\".\n4. 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. \n5. 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.\n6. 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..\n\n```yaml {title=\"data/config.yaml\"}\n# the default option\nsearch:\n enableSemanticSearch: true\n operandApiKey: \"jp9k5hudse2a828z98kxd6z3payi8u90rnjf\"\n operandIndexId: \"s0kf3bd6tldw\"\n```\n7. Push your changes to the site and wait for it to deploy.\n8. Check the Operand dashboard and wait for your site to index. Enjoy natural language search powered by Operand!\n", + "lastmodified": "2023-01-05T20:48:38.320229929Z", + "tags": null + }, + "/setup/setup": { + "title": "Setup", + "content": "\n## Getting Started\nSetting 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!\n\n### Forking\n\u003e A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.\n\nNavigate to the GitHub repository for the Amethyst project:\n\nπŸ“ [Amethyst Repository](https://github.com/64bitpandas/amethyst)\n\nThen, 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).\n\n### Cloning\nAfter 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.\n\n```shell\ngit clone https://github.com/YOUR-USERNAME/amethyst\n```\n\n## Editing\nGreat! 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:\n\n\u003e ✏️ Step 2: [Editing Notes in Amethyst](setup/editing.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](setup/troubleshooting.md).\n", + "lastmodified": "2023-01-05T20:29:17.588919796Z", + "tags": null + }, + "/setup/troubleshooting": { + "title": "Troubleshooting and FAQ", + "content": "\nStill having trouble? Here are a list of common questions and problems people encounter when installing Amethyst.\n\n### Does Amethyst have Latex support?\nYes! See [LaTeX](features/latex.md) for a brief demo.\n\n### Can I use \\\u003cObsidian Plugin\\\u003e in Amethyst?\nUnless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Amethyst.\n\nThe easiest way would be to add your own HTML partial that supports the functionality you are looking for.\n\n### My GitHub pages is just showing the README\nMake sure you set the source to deploy from the `deploy` branch (and not `main`) using `/ (root)`! See more in the [hosting](/setup/hosting) guide\n\n### Some of my pages have 'January 1, 0001' as the last modified date\nThis 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.\n\n```shell\n# in the root folder (same folder as config.toml)\ngit config core.ignorecase true\n\n# or globally (not recommended)\ngit config --global core.ignorecase true\n```\n\n### Can I publish only a subset of my pages?\nYes! Amethyst makes selective publishing really easy. Heres a guide on [excluding pages from being published](setup/ignore%20notes.md).\n\n### Can I host this myself and not on GitHub Pages?\nYes! All built files can be found under `/public` in the `master` branch. More details under [hosting](setup/hosting.md).\n\n### `command not found: hugo-obsidian`\nMake sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.\n\n```shell\n# Add the following 2 lines to your ~/.bash_profile\nexport GOPATH=/Users/$USER/go\nexport PATH=$GOPATH/bin:$PATH\n\n# In your current terminal, to reload the session\nsource ~/.bash_profile\n```\n\n### How come my notes aren't being rendered?\nYou 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).\n\n### My custom domain isn't working!\nWalk 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.\n\n### How do I setup Google Analytics?\nYou can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.\n\n### How do I change the content on the home page?\nTo edit the main home page, open `/content/_index.md`.\n\n### How do I change the colours?\nYou 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).\n\n### How do I add images?\nYou can put images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/setup/images/example.png)\n![Example Image](/content/setup/images/example.png)\n```\n\n### My Interactive Graph and Backlinks aren't up to date\nBy 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)\n\n### Can I use React/Vue/some other framework?\nNot 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.\n\n## Still Stuck?\nAmethyst 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!\n\nπŸ› [Submit an Issue](https://github.com/64bitpandas/amethyst/issues)", + "lastmodified": "2023-01-05T07:07:33.520765851Z", + "tags": null + }, + "/setup/updating": { + "title": "Updating", + "content": "\nHaven'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! \n\n```shell\nmake update\n```\n\nOr, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!)\n\n```shell\nmake update-force\n```\n\nOr, manually checkout the changes yourself.\n\n\u003e [!warning] Warning!\n\u003e\n\u003e If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!\n\u003e Make sure you have a copy of these changes if you don't want to lose them.\n\n\n```shell\n# add Amethyst as a remote host\ngit remote add upstream git@github.com:64bitpandas/amethyst.git\n\n# index and fetch changes\ngit fetch upstream\ngit checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss data \n```\n", + "lastmodified": "2023-01-05T20:50:13.64322657Z", + "tags": null } } \ No newline at end of file diff --git a/assets/indices/linkIndex.json b/assets/indices/linkIndex.json index c926484..a05a505 100644 --- a/assets/indices/linkIndex.json +++ b/assets/indices/linkIndex.json @@ -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" } ] } \ No newline at end of file diff --git a/assets/quartz/styles/base.scss b/assets/quartz/styles/base.scss index 6fcc92a..c7e8d55 100644 --- a/assets/quartz/styles/base.scss +++ b/assets/quartz/styles/base.scss @@ -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; diff --git a/assets/quartz/styles/custom.scss b/assets/quartz/styles/custom.scss index 04466ba..03dd984 100644 --- a/assets/quartz/styles/custom.scss +++ b/assets/quartz/styles/custom.scss @@ -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; -} \ No newline at end of file +// Add your own CSS here! \ No newline at end of file diff --git a/config.yaml b/config.yaml index 34d051e..a2a2a3e 100644 --- a/config.yaml +++ b/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 \ No newline at end of file diff --git a/content/_index.md b/content/_index.md index 28b690a..dcde4f1 100644 --- a/content/_index.md +++ b/content/_index.md @@ -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]] \ No newline at end of file +- 🚧 [Troubleshooting and FAQ](setup/troubleshooting.md) +- πŸ› [Submit an Issue](https://github.com/64bitpandas/amethyst/issues) +- πŸ‘€ [Contact me](https://bencuan.me/contact) diff --git a/content/configuration/_index.md b/content/configuration/_index.md deleted file mode 100644 index 83d610f..0000000 --- a/content/configuration/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -linkTitle: "Configuration" -weight: -5 ---- \ No newline at end of file diff --git a/content/configuration/config.md b/content/configuration/config.md deleted file mode 100644 index f0e63e4..0000000 --- a/content/configuration/config.md +++ /dev/null @@ -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=}` 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} - -``` - -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: | - - -``` - -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 -``` diff --git a/content/configuration/docker.md b/content/configuration/docker.md deleted file mode 100644 index e96ede3..0000000 --- a/content/configuration/docker.md +++ /dev/null @@ -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! diff --git a/content/configuration/editing.md b/content/configuration/editing.md deleted file mode 100644 index 4aaf585..0000000 --- a/content/configuration/editing.md +++ /dev/null @@ -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) -![Example Image](/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). diff --git a/content/configuration/hosting.md b/content/configuration/hosting.md deleted file mode 100644 index 7ff2fd0..0000000 --- a/content/configuration/hosting.md +++ /dev/null @@ -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](notes/images/github-actions.png)*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](/notes/images/github-pages.png)*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 - -# 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:///" -``` - -If you are using this under a subdomain (e.g. `.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!** - -```toml -baseURL = "https://.github.io/quartz/" -``` - -Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `.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: -``` - -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). diff --git a/content/features/callouts.md b/content/features/callouts.md index 74b837d..8926be0 100644 --- a/content/features/callouts.md +++ b/content/features/callouts.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) diff --git a/content/features/languages.md b/content/features/languages.md index 46215d7..09c513b 100644 --- a/content/features/languages.md +++ b/content/features/languages.md @@ -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. diff --git a/content/setup/_index.md b/content/setup/_index.md new file mode 100644 index 0000000..ee7d7b5 --- /dev/null +++ b/content/setup/_index.md @@ -0,0 +1,4 @@ +--- +linkTitle: "Getting Started" +weight: -5 +--- \ No newline at end of file diff --git a/content/setup/config.md b/content/setup/config.md new file mode 100644 index 0000000..0fd2734 --- /dev/null +++ b/content/setup/config.md @@ -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=}` 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} + +``` + +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: | + + +``` + +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). + + diff --git a/content/configuration/custom Domain.md b/content/setup/custom Domain.md similarity index 81% rename from content/configuration/custom Domain.md rename to content/setup/custom Domain.md index 72cb466..f96b3fc 100644 --- a/content/configuration/custom Domain.md +++ b/content/setup/custom Domain.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//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//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 ` πŸ”— 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). diff --git a/content/setup/hosting.md b/content/setup/hosting.md new file mode 100644 index 0000000..498d73d --- /dev/null +++ b/content/setup/hosting.md @@ -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](/setup/images/github-actions.png)*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](/setup/images/github-pages.png)*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 + +# 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:///" +``` + +If you are using this under a subdomain (e.g. `.github.io/amethyst/`), include the trailing `/`. **You need to do this especially if you are using GitHub!** + +```yaml +baseURL: "https://.github.io/amethyst/" +``` + +Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `.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: +``` + +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). diff --git a/content/configuration/ignore notes.md b/content/setup/ignore notes.md similarity index 67% rename from content/configuration/ignore notes.md rename to content/setup/ignore notes.md index e031421..15ba186 100644 --- a/content/configuration/ignore notes.md +++ b/content/setup/ignore notes.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/*", "" @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/content/configuration/images/github-actions.png b/content/setup/images/github-actions.png similarity index 100% rename from content/configuration/images/github-actions.png rename to content/setup/images/github-actions.png diff --git a/content/configuration/images/github-pages.png b/content/setup/images/github-pages.png similarity index 100% rename from content/configuration/images/github-pages.png rename to content/setup/images/github-pages.png diff --git a/content/configuration/images/google-domains.png b/content/setup/images/google-domains.png similarity index 100% rename from content/configuration/images/google-domains.png rename to content/setup/images/google-domains.png diff --git a/content/configuration/images/obsidian-settings.png b/content/setup/images/obsidian-settings.png similarity index 100% rename from content/configuration/images/obsidian-settings.png rename to content/setup/images/obsidian-settings.png diff --git a/content/configuration/obsidian.md b/content/setup/obsidian.md similarity index 56% rename from content/configuration/obsidian.md rename to content/setup/obsidian.md index c709a70..54a8a73 100644 --- a/content/configuration/obsidian.md +++ b/content/setup/obsidian.md @@ -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// 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](/notes/images/obsidian-settings.png)*Obsidian Settings* +![Obsidian Settings](/setup/images/obsidian-settings.png)*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) \ No newline at end of file +> πŸ‘€ Step 4: [Preview Changes](setup/preview%20changes.md) \ No newline at end of file diff --git a/content/configuration/preview changes.md b/content/setup/preview changes.md similarity index 58% rename from content/configuration/preview changes.md rename to content/setup/preview changes.md index 8ea07a3..ae7aee3 100644 --- a/content/configuration/preview changes.md +++ b/content/setup/preview changes.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 +# Navigate to your local Amethyst folder +cd # 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) diff --git a/content/configuration/search.md b/content/setup/search.md similarity index 85% rename from content/configuration/search.md rename to content/setup/search.md index 0457693..0a07905 100644 --- a/content/configuration/search.md +++ b/content/setup/search.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.. diff --git a/content/configuration/setup.md b/content/setup/setup.md similarity index 50% rename from content/configuration/setup.md rename to content/setup/setup.md index 0025415..a583910 100644 --- a/content/configuration/setup.md +++ b/content/setup/setup.md @@ -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). diff --git a/content/configuration/troubleshooting.md b/content/setup/troubleshooting.md similarity index 51% rename from content/configuration/troubleshooting.md rename to content/setup/troubleshooting.md index 66eb879..0aa4bb0 100644 --- a/content/configuration/troubleshooting.md +++ b/content/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 \ 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 \ 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](/content/notes/images/example.png) +Example image (source is in content/setup/images/example.png) +![Example Image](/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) \ No newline at end of file +πŸ› [Submit an Issue](https://github.com/64bitpandas/amethyst/issues) \ No newline at end of file diff --git a/content/configuration/updating.md b/content/setup/updating.md similarity index 51% rename from content/configuration/updating.md rename to content/setup/updating.md index ef4688e..218740c 100644 --- a/content/configuration/updating.md +++ b/content/setup/updating.md @@ -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 ``` diff --git a/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.content b/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.content index d0c13b4..8d02bc1 100644 --- a/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.content +++ b/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.content @@ -1 +1 @@ -@charset "UTF-8";/*!normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css*/html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}.flex{display:flex}.flex-auto{flex:auto}.flex-even{flex:1 1}.flex-wrap{flex-wrap:wrap}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.align-center{align-items:center}.mx-auto{margin:0 auto}.text-center{text-align:center}.text-left{text-align:left}.text-right{text-align:right}.hidden{display:none}input.toggle{height:0;width:0;overflow:hidden;opacity:0;position:absolute}.clearfix::after{content:"";display:table;clear:both}html{font-size:16px;scroll-behavior:smooth;touch-action:manipulation}body{min-width:20rem;color:var(--body-font-color);background:var(--body-background);letter-spacing:.33px;font-weight:400;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;box-sizing:border-box}body *{box-sizing:inherit}h1,h2,h3,h4,h5{font-weight:400}a{text-decoration:none;color:var(--color-link)}img{vertical-align:baseline}aside nav ul{padding:0;margin:0;list-style:none}aside nav ul li{margin:1em 0;position:relative}aside nav ul a{display:block}aside nav ul a:hover{opacity:.5}aside nav ul ul{padding-inline-start:1rem}ul.pagination{display:flex;justify-content:center;list-style-type:none;padding-inline-start:0}ul.pagination .page-item a{padding:1rem}.container{max-width:65rem;margin:0 auto}.book-icon{filter:var(--icon-filter)}.book-brand{margin-top:0;margin-bottom:1rem}.book-brand img{height:1.5em;width:1.5em;margin-inline-end:.5rem}.book-menu{flex:0 0 16rem;font-size:.875rem}.book-menu .book-menu-content{width:16rem;padding:1rem;background:var(--body-background);position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-menu a,.book-menu label{color:inherit;cursor:pointer;word-wrap:break-word}.book-menu a.active{color:var(--color-link)}.book-menu input.toggle+label+ul{display:none}.book-menu input.toggle:checked+label+ul{display:block}.book-menu input.toggle+label::after{content:"β–Έ"}.book-menu input.toggle:checked+label::after{content:"β–Ύ"}body[dir=rtl] .book-menu input.toggle+label::after{content:"β—‚"}body[dir=rtl] .book-menu input.toggle:checked+label::after{content:"β–Ύ"}.book-section-flat{margin:1rem 0}.book-section-flat>a,.book-section-flat>span,.book-section-flat>label{font-weight:bolder}.book-section-flat>ul{padding-inline-start:0}.book-page{min-width:20rem;flex-grow:1;padding:1rem}.book-post{margin-bottom:3rem}.book-search{position:relative;margin:1rem 0;border-bottom:1px solid transparent}.book-search input{width:100%;padding:.5rem;border:0;border-radius:.25rem;background:var(--gray-100);color:var(--body-font-color)}.book-search input:required+.book-search-spinner{display:block}.book-search .book-search-spinner{position:absolute;top:0;margin:.5rem;margin-inline-start:calc(100% - 1.5rem);width:1rem;height:1rem;border:1px solid transparent;border-top-color:var(--body-font-color);border-radius:50%;animation:spin 1s ease infinite}@keyframes spin{100%{transform:rotate(360deg)}}.book-search small{opacity:.5}.book-toc{flex:0 0 12rem;font-size:.75rem}.book-toc .book-toc-content{width:12rem;padding:1rem;position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-toc img{height:1em;width:1em}.book-toc nav>ul>li:first-child{margin-top:0}.book-footer{padding-top:1rem;font-size:.875rem}.book-footer img{height:1em;width:1em;margin-inline-end:.5rem}.book-comments{margin-top:1rem}.book-languages{margin-block-end:2rem}.book-languages .book-icon{height:1em;width:1em;margin-inline-end:.5em}.book-languages ul{padding-inline-start:1.5em}.book-menu-content,.book-toc-content,.book-page,.book-header aside,.markdown{transition:.2s ease-in-out;transition-property:transform,margin,opacity,visibility;will-change:transform,margin,opacity}@media screen and (max-width:52rem){#menu-control,#toc-control{display:inline}.book-menu{visibility:hidden;margin-inline-start:-16rem;font-size:16px;z-index:1}.book-toc{display:none}.book-header{display:block}#menu-control:focus~main label[for=menu-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#menu-control:checked~main .book-menu{visibility:initial}#menu-control:checked~main .book-menu .book-menu-content{transform:translateX(16rem);box-shadow:0 0 .5rem rgba(0,0,0,.1)}#menu-control:checked~main .book-page{opacity:.25}#menu-control:checked~main .book-menu-overlay{display:block;position:absolute;top:0;bottom:0;left:0;right:0}#toc-control:focus~main label[for=toc-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#toc-control:checked~main .book-header aside{display:block}body[dir=rtl] #menu-control:checked~main .book-menu .book-menu-content{transform:translateX(-16rem)}}@media screen and (min-width:65rem){.book-page,.book-menu .book-menu-content,.book-toc .book-toc-content{padding:2rem 1rem}}@font-face{font-family:pp mori;font-style:normal;font-weight:400;src:url(fonts/PPMori-SemiBold.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:lighter;src:url(fonts/PPMori-Book.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:700;src:url(fonts/PPMori-SemiBold.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:1000;src:url(fonts/PPMori-ExtraBold.woff2)}@font-face{font-family:pp mori;font-style:italic;font-weight:400;src:url(fonts/PPMori-RegularItalic.woff2)}@font-face{font-family:pp mori;font-style:italic;font-weight:700;src:url(fonts/PPMori-SemiBoldItalic.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:400;src:url(fonts/PPFraktionMono-Regular.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:lighter;src:url(fonts/PPFraktionMono-Light.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:700;src:url(fonts/PPFraktionMono-Bold.woff2)}@font-face{font-family:pp fraktion mono;font-style:italic;font-weight:400;src:url(fonts/PPFraktionMono-RegularItalic.woff2)}@font-face{font-family:pp fraktion mono;font-style:italic;font-weight:700;src:url(fonts/PPFraktionMono-BoldItalic.woff2)}@media print{.book-menu,.book-footer,.book-toc{display:none}.book-header,.book-header aside{display:block}main{display:block!important}}.markdown{line-height:1.6}.markdown>:first-child{margin-top:0}.markdown h1,.markdown h2,.markdown h3,.markdown h4,.markdown h5,.markdown h6{font-weight:400;line-height:1;margin-top:1.5em;margin-bottom:1rem}.markdown h1 a.anchor,.markdown h2 a.anchor,.markdown h3 a.anchor,.markdown h4 a.anchor,.markdown h5 a.anchor,.markdown h6 a.anchor{opacity:0;font-size:.75em;vertical-align:middle;text-decoration:none}.markdown h1:hover a.anchor,.markdown h1 a.anchor:focus,.markdown h2:hover a.anchor,.markdown h2 a.anchor:focus,.markdown h3:hover a.anchor,.markdown h3 a.anchor:focus,.markdown h4:hover a.anchor,.markdown h4 a.anchor:focus,.markdown h5:hover a.anchor,.markdown h5 a.anchor:focus,.markdown h6:hover a.anchor,.markdown h6 a.anchor:focus{opacity:initial}.markdown h4,.markdown h5,.markdown h6{font-weight:bolder}.markdown h5{font-size:.875em}.markdown h6{font-size:.75em}.markdown b,.markdown optgroup,.markdown strong{font-weight:bolder}.markdown a{text-decoration:none}.markdown a:hover{text-decoration:underline}.markdown img{max-width:100%;height:auto}.markdown code{padding:0 .25rem;background:var(--gray-200);border-radius:.25rem;font-size:.875em}.markdown pre{padding:1rem;background:var(--gray-100);border-radius:.25rem;overflow-x:auto}.markdown pre code{padding:0;background:0 0}.markdown p{word-wrap:break-word}.markdown table{overflow:auto;display:block;border-spacing:0;border-collapse:collapse;margin-top:1rem;margin-bottom:1rem}.markdown table tr th,.markdown table tr td{padding:.5rem 1rem;border:1px solid var(--gray-200)}.markdown table tr:nth-child(2n){background:var(--gray-100)}.markdown hr{height:1px;border:none;background:var(--gray-200)}.markdown ul,.markdown ol{padding-inline-start:2rem}.markdown dl dt{font-weight:bolder;margin-top:1rem}.markdown dl dd{margin-inline-start:0;margin-bottom:1rem}.markdown .highlight table tr td:nth-child(1) pre{margin:0;padding-inline-end:0}.markdown .highlight table tr td:nth-child(2) pre{margin:0;padding-inline-start:0}.markdown details{padding:1rem;border:none!important;font-family:var(--font-body);font-weight:700;color:var(--dark)}.markdown details summary{line-height:1;padding:1rem;margin:-1rem;cursor:pointer}.markdown details[open] summary{margin-bottom:0}.markdown figure{margin:1rem 0}.markdown figure figcaption p{margin-top:0}.markdown-inner>:first-child{margin-top:0}.markdown-inner>:last-child{margin-bottom:0}.markdown .book-expand{margin-top:1rem;margin-bottom:1rem;border:2px solid var(--secondary);border-radius:.25rem;overflow:hidden}.markdown .book-expand .book-expand-head{color:var(--secondary);font-family:var(--font-body);padding:.5rem 1rem;cursor:pointer;font-weight:700}.markdown .book-expand .book-expand-content{display:none;padding:1rem}.markdown .book-expand input[type=checkbox]:checked+.book-expand-content{display:block}.markdown .book-tabs{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden;display:flex;flex-wrap:wrap}.markdown .book-tabs label{display:inline-block;padding:.5rem 1rem;border-bottom:1px transparent;cursor:pointer}.markdown .book-tabs .book-tabs-content{order:999;width:100%;border-top:1px solid var(--gray-100);padding:1rem;display:none}.markdown .book-tabs input[type=radio]:checked+label{border-bottom:1px solid var(--color-link)}.markdown .book-tabs input[type=radio]:checked+label+.book-tabs-content{display:block}.markdown .book-tabs input[type=radio]:focus+label{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}.markdown .book-columns{margin-left:-1rem;margin-right:-1rem}.markdown .book-columns>div{margin:1rem 0;min-width:10rem;padding:0 1rem}.markdown a.book-btn{display:inline-block;font-size:.875rem;color:var(--secondary);line-height:2rem;padding:0 1rem;border:1px solid var(--secondary);border-radius:.25rem;cursor:pointer}.markdown a.book-btn:hover{text-decoration:none}.markdown .book-hint.info{border-color:#6bf;background-color:rgba(102,187,255,.1)}.markdown .book-hint.warning{border-color:#fd6;background-color:rgba(255,221,102,.1)}.markdown .book-hint.danger{border-color:#f66;background-color:rgba(255,102,102,.1)}header{position:fixed;width:100%;padding:0 80px;z-index:9999;background-color:var(--header);margin:0!important;height:80px}.book-menu,.book-menu-content,.book-toc-content,.book-page{margin-top:80px}.book-header{display:flex;padding:30px}#page-title a{color:var(--dark)}@media screen and (max-width:52rem){.book-header{justify-content:space-between}#page-title{text-align:center;width:100%;padding:0}.menu-search{display:block}.menu-search #search-icon{width:100%;justify-content:space-between}header #search-icon{display:none!important}}@media screen and (min-width:52rem){.book-icon{display:none}.menu-search{display:none!important}header #search-icon{display:block;margin-right:20px}}.book-toc-content::-webkit-scrollbar,.book-menu-content::-webkit-scrollbar{width:10px;height:16px}pre::-webkit-scrollbar{width:8px;height:10px}*::-webkit-scrollbar-thumb{background:grey;border-radius:8px}*::-webkit-scrollbar-track{background-color:#ddd}.markdown h1,.markdown h2,.markdown h3{font-weight:700}.title{color:var(--secondary);font-size:3rem;padding-bottom:1rem}.book-toc-content{font-weight:400}.book-menu-content a:hover,.book-toc-content a:hover{opacity:100%} \ No newline at end of file +@charset "UTF-8";/*!normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css*/@import "https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&family=Source+Sans+Pro:wght@400;600&display=swap";html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}.flex{display:flex}.flex-auto{flex:auto}.flex-even{flex:1 1}.flex-wrap{flex-wrap:wrap}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.align-center{align-items:center}.mx-auto{margin:0 auto}.text-center{text-align:center}.text-left{text-align:left}.text-right{text-align:right}.hidden{display:none}input.toggle{height:0;width:0;overflow:hidden;opacity:0;position:absolute}.clearfix::after{content:"";display:table;clear:both}html{font-size:16px;scroll-behavior:smooth;touch-action:manipulation}body{min-width:20rem;color:var(--body-font-color);background:var(--body-background);letter-spacing:.33px;font-weight:400;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;box-sizing:border-box}body *{box-sizing:inherit}h1,h2,h3,h4,h5{font-weight:400}a{text-decoration:none;color:var(--color-link)}img{vertical-align:baseline}aside nav ul{padding:0;margin:0;list-style:none}aside nav ul li{margin:1em 0;position:relative}aside nav ul a{display:block}aside nav ul a:hover{opacity:.5}aside nav ul ul{padding-inline-start:1rem}ul.pagination{display:flex;justify-content:center;list-style-type:none;padding-inline-start:0}ul.pagination .page-item a{padding:1rem}.container{max-width:65rem;margin:0 auto}.book-icon{filter:var(--icon-filter)}.book-brand{margin-top:0;margin-bottom:1rem}.book-brand img{height:1.5em;width:1.5em;margin-inline-end:.5rem}.book-menu{flex:0 0 16rem;font-size:.875rem}.book-menu .book-menu-content{width:16rem;padding:1rem;background:var(--body-background);position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-menu a,.book-menu label{color:inherit;cursor:pointer;word-wrap:break-word}.book-menu a.active{color:var(--color-link)}.book-menu input.toggle+label+ul{display:none}.book-menu input.toggle:checked+label+ul{display:block}.book-menu input.toggle+label::after{content:"β–Έ"}.book-menu input.toggle:checked+label::after{content:"β–Ύ"}body[dir=rtl] .book-menu input.toggle+label::after{content:"β—‚"}body[dir=rtl] .book-menu input.toggle:checked+label::after{content:"β–Ύ"}.book-section-flat{margin:1rem 0}.book-section-flat>a,.book-section-flat>span,.book-section-flat>label{font-weight:bolder}.book-section-flat>ul{padding-inline-start:0}.book-page{min-width:20rem;flex-grow:1;padding:1rem}.book-post{margin-bottom:3rem}.book-search{position:relative;margin:1rem 0;border-bottom:1px solid transparent}.book-search input{width:100%;padding:.5rem;border:0;border-radius:.25rem;background:var(--gray-100);color:var(--body-font-color)}.book-search input:required+.book-search-spinner{display:block}.book-search .book-search-spinner{position:absolute;top:0;margin:.5rem;margin-inline-start:calc(100% - 1.5rem);width:1rem;height:1rem;border:1px solid transparent;border-top-color:var(--body-font-color);border-radius:50%;animation:spin 1s ease infinite}@keyframes spin{100%{transform:rotate(360deg)}}.book-search small{opacity:.5}.book-toc{flex:0 0 12rem;font-size:.75rem}.book-toc .book-toc-content{width:12rem;padding:1rem;position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-toc img{height:1em;width:1em}.book-toc nav>ul>li:first-child{margin-top:0}.book-footer{padding-top:1rem;font-size:.875rem}.book-footer img{height:1em;width:1em;margin-inline-end:.5rem}.book-comments{margin-top:1rem}.book-languages{margin-block-end:2rem}.book-languages .book-icon{height:1em;width:1em;margin-inline-end:.5em}.book-languages ul{padding-inline-start:1.5em}.book-menu-content,.book-toc-content,.book-page,.book-header aside,.markdown{transition:.2s ease-in-out;transition-property:transform,margin,opacity,visibility;will-change:transform,margin,opacity}@media screen and (max-width:52rem){#menu-control,#toc-control{display:inline}.book-menu{visibility:hidden;margin-inline-start:-16rem;font-size:16px;z-index:1}.book-toc{display:none}.book-header{display:block}#menu-control:focus~main label[for=menu-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#menu-control:checked~main .book-menu{visibility:initial}#menu-control:checked~main .book-menu .book-menu-content{transform:translateX(16rem);box-shadow:0 0 .5rem rgba(0,0,0,.1)}#menu-control:checked~main .book-page{opacity:.25}#menu-control:checked~main .book-menu-overlay{display:block;position:absolute;top:0;bottom:0;left:0;right:0}#toc-control:focus~main label[for=toc-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#toc-control:checked~main .book-header aside{display:block}body[dir=rtl] #menu-control:checked~main .book-menu .book-menu-content{transform:translateX(-16rem)}}@media screen and (min-width:65rem){.book-page,.book-menu .book-menu-content,.book-toc .book-toc-content{padding:2rem 1rem}}: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;font-weight:400;src:url(fonts/PPMori-SemiBold.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:lighter;src:url(fonts/PPMori-Book.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:700;src:url(fonts/PPMori-SemiBold.woff2)}@font-face{font-family:pp mori;font-style:normal;font-weight:1000;src:url(fonts/PPMori-ExtraBold.woff2)}@font-face{font-family:pp mori;font-style:italic;font-weight:400;src:url(fonts/PPMori-RegularItalic.woff2)}@font-face{font-family:pp mori;font-style:italic;font-weight:700;src:url(fonts/PPMori-SemiBoldItalic.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:400;src:url(fonts/PPFraktionMono-Regular.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:lighter;src:url(fonts/PPFraktionMono-Bold.woff2)}@font-face{font-family:pp fraktion mono;font-style:normal;font-weight:700;src:url(fonts/PPFraktionMono-Bold.woff2)}@font-face{font-family:pp fraktion mono;font-style:italic;font-weight:400;src:url(fonts/PPFraktionMono-RegularItalic.woff2)}@font-face{font-family:pp fraktion mono;font-style:italic;font-weight:700;src:url(fonts/PPFraktionMono-BoldItalic.woff2)}@media print{.book-menu,.book-footer,.book-toc{display:none}.book-header,.book-header aside{display:block}main{display:block!important}}.markdown{line-height:1.6}.markdown>:first-child{margin-top:0}.markdown h1,.markdown h2,.markdown h3,.markdown h4,.markdown h5,.markdown h6{font-weight:400;line-height:1;margin-top:1.5em;margin-bottom:1rem}.markdown h1 a.anchor,.markdown h2 a.anchor,.markdown h3 a.anchor,.markdown h4 a.anchor,.markdown h5 a.anchor,.markdown h6 a.anchor{opacity:0;font-size:.75em;vertical-align:middle;text-decoration:none}.markdown h1:hover a.anchor,.markdown h1 a.anchor:focus,.markdown h2:hover a.anchor,.markdown h2 a.anchor:focus,.markdown h3:hover a.anchor,.markdown h3 a.anchor:focus,.markdown h4:hover a.anchor,.markdown h4 a.anchor:focus,.markdown h5:hover a.anchor,.markdown h5 a.anchor:focus,.markdown h6:hover a.anchor,.markdown h6 a.anchor:focus{opacity:initial}.markdown h4,.markdown h5,.markdown h6{font-weight:bolder}.markdown h5{font-size:.875em}.markdown h6{font-size:.75em}.markdown b,.markdown optgroup,.markdown strong{font-weight:bolder}.markdown a{text-decoration:none}.markdown a:hover{text-decoration:underline}.markdown img{max-width:100%;height:auto}.markdown code{padding:0 .25rem;background:var(--gray-200);border-radius:.25rem;font-size:.875em}.markdown pre{padding:1rem;background:var(--gray-100);border-radius:.25rem;overflow-x:auto}.markdown pre code{padding:0;background:0 0}.markdown p{word-wrap:break-word}.markdown table{overflow:auto;display:block;border-spacing:0;border-collapse:collapse;margin-top:1rem;margin-bottom:1rem}.markdown table tr th,.markdown table tr td{padding:.5rem 1rem;border:1px solid var(--gray-200)}.markdown table tr:nth-child(2n){background:var(--gray-100)}.markdown hr{height:1px;border:none;background:var(--gray-200)}.markdown ul,.markdown ol{padding-inline-start:2rem}.markdown dl dt{font-weight:bolder;margin-top:1rem}.markdown dl dd{margin-inline-start:0;margin-bottom:1rem}.markdown .highlight table tr td:nth-child(1) pre{margin:0;padding-inline-end:0}.markdown .highlight table tr td:nth-child(2) pre{margin:0;padding-inline-start:0}.markdown details{padding:1rem;border:none!important;font-family:var(--font-body);font-weight:700;color:var(--dark)}.markdown details summary{line-height:1;padding:1rem;margin:-1rem;cursor:pointer}.markdown details[open] summary{margin-bottom:0}.markdown figure{margin:1rem 0}.markdown figure figcaption p{margin-top:0}.markdown-inner>:first-child{margin-top:0}.markdown-inner>:last-child{margin-bottom:0}.markdown .book-expand{margin-top:1rem;margin-bottom:1rem;border:2px solid var(--secondary);border-radius:.25rem;overflow:hidden}.markdown .book-expand .book-expand-head{color:var(--secondary);font-family:var(--font-body);padding:.5rem 1rem;cursor:pointer;font-weight:700}.markdown .book-expand .book-expand-content{display:none;padding:1rem}.markdown .book-expand input[type=checkbox]:checked+.book-expand-content{display:block}.markdown .book-tabs{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden;display:flex;flex-wrap:wrap}.markdown .book-tabs label{display:inline-block;padding:.5rem 1rem;border-bottom:1px transparent;cursor:pointer}.markdown .book-tabs .book-tabs-content{order:999;width:100%;border-top:1px solid var(--gray-100);padding:1rem;display:none}.markdown .book-tabs input[type=radio]:checked+label{border-bottom:1px solid var(--color-link)}.markdown .book-tabs input[type=radio]:checked+label+.book-tabs-content{display:block}.markdown .book-tabs input[type=radio]:focus+label{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}.markdown .book-columns{margin-left:-1rem;margin-right:-1rem}.markdown .book-columns>div{margin:1rem 0;min-width:10rem;padding:0 1rem}.markdown a.book-btn{display:inline-block;font-size:.875rem;color:var(--secondary);line-height:2rem;padding:0 1rem;border:1px solid var(--secondary);border-radius:.25rem;cursor:pointer}.markdown a.book-btn:hover{text-decoration:none}.markdown .book-hint.info{border-color:#6bf;background-color:rgba(102,187,255,.1)}.markdown .book-hint.warning{border-color:#fd6;background-color:rgba(255,221,102,.1)}.markdown .book-hint.danger{border-color:#f66;background-color:rgba(255,102,102,.1)}: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}header{position:fixed;width:100%;padding:0 80px;z-index:9999;background-color:var(--header);margin:0!important;height:80px}.book-menu,.book-menu-content,.book-toc-content,.book-page{margin-top:80px}.book-header{display:flex;padding:30px}#page-title a{color:var(--dark)}@media screen and (max-width:52rem){.book-header{justify-content:space-between}#page-title{text-align:center;width:100%;padding:0}.menu-search{display:block}.menu-search #search-icon{width:100%;justify-content:space-between}header #search-icon{display:none!important}}@media screen and (min-width:52rem){.book-icon{display:none}.menu-search{display:none!important}header #search-icon{display:block;margin-right:20px}}.book-toc-content::-webkit-scrollbar,.book-menu-content::-webkit-scrollbar{width:10px;height:16px}pre::-webkit-scrollbar{width:8px;height:10px}*::-webkit-scrollbar-thumb{background:grey;border-radius:8px}*::-webkit-scrollbar-track{background-color:#ddd}.markdown h1,.markdown h2,.markdown h3{font-weight:700}.title{color:var(--secondary);font-size:3rem;padding-bottom:1rem}.book-toc-content{font-weight:400}.book-menu-content a:hover,.book-toc-content a:hover{opacity:100%} \ No newline at end of file diff --git a/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json b/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json index 2a8be91..6edfd3d 100644 --- a/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json +++ b/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json @@ -1 +1 @@ -{"Target":"book.min.6741a91dfc96b335f886b059f193a9ad54e5c3a35808bee087ae3fc6c9274900.css","MediaType":"text/css","Data":{"Integrity":"sha256-Z0GpHfyWszX4hrBZ8ZOprVTlw6NYCL7gh64/xsknSQA="}} \ No newline at end of file +{"Target":"book.min.f18b2f2e7298d59ed739b8246efa7a6ed7b02ad880c55ab44840973285a77edd.css","MediaType":"text/css","Data":{"Integrity":"sha256-8YsvLnKY1Z7XObgkbvp6btewKtiAxVq0SECXMoWnft0="}} \ No newline at end of file diff --git a/resources/_gen/assets/scss/quartz/styles/base.scss_0ccffbd39a5ea808aa33646cb7c2a662.content b/resources/_gen/assets/scss/quartz/styles/base.scss_0ccffbd39a5ea808aa33646cb7c2a662.content index 3a2d169..1425bbe 100644 --- a/resources/_gen/assets/scss/quartz/styles/base.scss_0ccffbd39a5ea808aa33646cb7c2a662.content +++ b/resources/_gen/assets/scss/quartz/styles/base.scss_0ccffbd39a5ea808aa33646cb7c2a662.content @@ -1 +1 @@ -@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}html{scroll-behavior:smooth}html:lang(ar) p,html:lang(ar) h1,html:lang(ar) h2,html:lang(ar) h3,html:lang(ar) article,html:lang(ar) header{direction:rtl;text-align:right}html footer>p{text-align:center !important}.singlePage{padding:4em 30vw}@media all and (max-width: 1200px){.singlePage{padding:25px 5vw}}body{margin:0;height:100vh;width:100vw;max-width:100%;box-sizing:border-box;background-color:var(--light)}h1,h2,h3,h4,h5,h6,thead{font-family:var(--font-header);color:var(--dark);font-weight:revert;margin:2rem 0 0;padding:2rem auto 1rem}h1:hover>.hanchor,h2:hover>.hanchor,h3:hover>.hanchor,h4:hover>.hanchor,h5:hover>.hanchor,h6:hover>.hanchor,thead:hover>.hanchor{color:var(--secondary)}.hanchor{font-family:var(--font-header);opacity:0.8;transition:color 0.3s ease;color:var(--dark)}p,ul,text,a,tr,td,li,ol,ul{font-family:var(--font-body);color:var(--gray);fill:var(--gray);font-weight:normal;margin:revert;padding:revert}tbody,li,p{line-height:1.5em}.mainTOC{border-radius:5px;padding:0.75em 0}.mainTOC details summary{cursor:zoom-in;font-family:var(--font-header);color:var(--dark);font-weight:700}.mainTOC details[open] summary{cursor:zoom-out}#TableOfContents>ol{counter-reset:section;margin-left:0;padding-left:1.5em}#TableOfContents>ol>li{counter-increment:section}#TableOfContents>ol>li>ol{counter-reset:subsection}#TableOfContents>ol>li>ol>li{counter-increment:subsection}#TableOfContents>ol>li>ol>li::marker{content:counter(section) "." counter(subsection) " "}#TableOfContents>ol>li::marker{content:counter(section) " "}#TableOfContents>ol>li::marker,#TableOfContents>ol>li>ol>li::marker{font-family:var(--font-body);font-weight:700}table{border:1px solid var(--outlinegray);width:100%;padding:1.5em;border-collapse:collapse}td,th{padding:0.2em 1em;border:1px solid var(--outlinegray)}img{max-width:100%;border-radius:3px;margin:1em 0}p>img+em{display:block;transform:translateY(-1em)}sup{line-height:0}blockquote{margin-left:0;border-left:3px solid var(--secondary);padding-left:1em;transition:border-color 0.2s ease}.footnotes p{margin:0.5em 0}.pagination{list-style:none;padding-left:0;display:flex;margin-top:2em;gap:1.5em;justify-content:center}.pagination .disabled{opacity:0.2}.pagination>li{text-align:center;display:inline-block}.pagination>li a{background-color:transparent !important}.pagination>li a[href$="#"],.pagination>li.active a{opacity:0.2}article>h1{margin-top:2em;font-size:2em}article>.meta{margin:0 0 1em 0;opacity:0.7}article a{font-weight:600}article a.internal-link{text-decoration:none;background-color:rgba(143,159,169,0.15);padding:0 0.1em;margin:auto -0.1em;border-radius:3px}article a.internal-link.broken{opacity:0.5;background-color:transparent}article p{overflow-wrap:anywhere}.tags{list-style:none;padding-left:0}.tags .meta{margin:1.5em 0}.tags .meta>h1{margin:0}.tags .meta>p{margin:0}.tags>li{display:inline-block;margin:0.4em 0.2em}.tags>li>a{border-radius:8px;border:var(--outlinegray) 1px solid;padding:0.2em 0.5em}.tags>li>a::before{content:"#";margin-right:0.3em;color:var(--outlinegray)}.backlinks a{font-weight:600;font-size:0.9rem}sup>a{text-decoration:none;padding:0 0.1em 0 0.2em}#page-title{margin:0}#page-title>a{font-family:var(--font-header)}a{font-size:1em;font-weight:700;text-decoration:none;transition:all 0.2s ease;color:var(--secondary)}a:hover{color:var(--tertiary) !important}pre{font-family:var(--font-mono);padding:0.75em;border-radius:3px;overflow-x:scroll}code{font-family:var(--font-mono);font-size:0.85em;padding:0.15em 0.3em;border-radius:5px;background:var(--lightgray)}@keyframes fadeIn{0%{opacity:0}100%{opacity:1}}footer{margin-top:4em;text-align:center}footer ul{padding-left:0}hr{width:100%;margin:2em auto;height:1px;border:none;background-color:var(--outlinegray)}.page-end{display:flex;flex-direction:row;gap:2em}@media all and (max-width: 780px){.page-end{flex-direction:column}}.page-end>*{flex:1 0 0}.page-end>.backlinks-container>ul{list-style:none;padding:0;margin:0}.page-end>.backlinks-container>ul>li{margin:0.5em 0;padding:0.25em 1em;border:var(--outlinegray) 1px solid;border-radius:5px}.page-end #graph-container{border:var(--outlinegray) 1px solid;border-radius:5px;box-sizing:border-box;min-height:250px;margin:0.5em 0}.page-end #graph-container>svg{margin-bottom:-5px}.centered{margin-top:30vh}.spacer{flex:1 1 auto}header,.menu-search{display:flex;flex-direction:row;align-items:center;margin:2em 1em 2em}header>h1,.menu-search>h1{font-size:2em}@media all and (max-width: 600px){header>nav,.menu-search>nav{display:none}}header #search-icon,.menu-search #search-icon{background-color:var(--lightgray);border-radius:4px;height:2em;display:flex;align-items:center;cursor:pointer}header #search-icon>p,.menu-search #search-icon>p{display:inline;padding:0 1.5em 0 2em}header svg,.menu-search svg{cursor:pointer;width:18px;min-width:18px;margin:0 0.5em}header svg:hover .search-path,.menu-search svg:hover .search-path{stroke:var(--tertiary)}header svg .search-path,.menu-search svg .search-path{stroke:var(--gray);stroke-width:2px;transition:stroke 0.5s ease}#search-container{position:fixed;z-index:9999;left:0;top:0;width:100vw;height:100%;overflow:scroll;display:none;backdrop-filter:blur(4px);-webkit-backdrop-filter:blur(4px)}#search-container>div{width:50%;margin-top:15vh;margin-left:auto;margin-right:auto}@media all and (max-width: 1200px){#search-container>div{width:90%}}#search-container>div>*{width:100%;border-radius:4px;background:var(--light);box-shadow:0 14px 50px rgba(27,33,48,0.12),0 10px 30px rgba(27,33,48,0.16);margin-bottom:2em}#search-container>div>input{box-sizing:border-box;padding:0.5em 1em;font-family:var(--font-body);color:var(--dark);font-size:1.1em;border:1px solid var(--outlinegray)}#search-container>div>input:focus{outline:none}#search-container>div>#results-container .result-card{padding:1em;cursor:pointer;transition:background 0.2s ease;border:1px solid var(--outlinegray);border-bottom:none;width:100%;font-family:inherit;font-size:100%;line-height:1.15;margin:0;overflow:visible;text-transform:none;text-align:left;background:var(--light);outline:none}#search-container>div>#results-container .result-card:hover,#search-container>div>#results-container .result-card:focus{background:rgba(180,180,180,0.15)}#search-container>div>#results-container .result-card:first-of-type{border-top-left-radius:5px;border-top-right-radius:5px}#search-container>div>#results-container .result-card:last-of-type{border-bottom-left-radius:5px;border-bottom-right-radius:5px;border-bottom:1px solid var(--outlinegray)}#search-container>div>#results-container .result-card>h3,#search-container>div>#results-container .result-card>p{margin:0}.search-highlight{background-color:#afbfc966;padding:0.05em 0.2em;border-radius:3px}.section-ul{list-style:none;margin-top:2em;padding-left:0}.section-li{margin-bottom:1em}.section-li>.section{display:flex;align-items:center}@media all and (max-width: 600px){.section-li>.section .tags{display:none}}.section-li>.section h3>a{font-weight:700;margin:0}.section-li>.section p{margin:0;padding-right:1em;flex-basis:6em}.section-li h3{opacity:1;font-weight:700;margin:0}.section-li .meta{opacity:0.6}@keyframes dropin{0%{display:none;opacity:0;visibility:hidden}1%{display:inline-block;opacity:0}100%{opacity:1;visibility:visible}}.popover{z-index:999;position:absolute;width:20rem;display:none;background-color:var(--light);padding:1rem;margin:1rem;border:1px solid var(--outlinegray);border-radius:5px;pointer-events:none;transition:opacity 0.2s ease, transform 0.2s ease;user-select:none;overflow-wrap:anywhere;box-shadow:6px 6px 36px 0 rgba(0,0,0,0.25)}@media all and (max-width: 600px){.popover{display:none !important}}.popover.visible{opacity:1;visibility:visible;display:inline-block;animation:dropin 0.2s ease}.popover>h3{font-size:1rem;margin:0.25rem 0}.popover .meta{margin-top:0.25rem;opacity:0.5;font-family:var(--font-mono);font-size:0.8rem}.popover>p{margin:0;padding:0.5rem 0}.popover>p,.popover>a{font-size:1rem;font-weight:400;user-select:none}#contact_buttons ul{list-style-type:none}#contact_buttons ul li{display:inline-block}#contact_buttons ul li a{padding:0 1em}mark{background-color:var(--highlighted);color:var(--gray)} +html{scroll-behavior:smooth}html:lang(ar) p,html:lang(ar) h1,html:lang(ar) h2,html:lang(ar) h3,html:lang(ar) article,html:lang(ar) header{direction:rtl;text-align:right}html footer>p{text-align:center !important}.singlePage{padding:4em 30vw}@media all and (max-width: 1200px){.singlePage{padding:25px 5vw}}body{margin:0;height:100vh;width:100vw;max-width:100%;box-sizing:border-box;background-color:var(--light)}h1,h2,h3,h4,h5,h6,thead{font-family:var(--font-header);color:var(--dark);font-weight:revert;margin:2rem 0 0;padding:2rem auto 1rem}h1:hover>.hanchor,h2:hover>.hanchor,h3:hover>.hanchor,h4:hover>.hanchor,h5:hover>.hanchor,h6:hover>.hanchor,thead:hover>.hanchor{color:var(--secondary)}.hanchor{font-family:var(--font-header);opacity:0.8;transition:color 0.3s ease;color:var(--dark)}p,ul,text,a,tr,td,li,ol,ul{font-family:var(--font-body);color:var(--gray);fill:var(--gray);font-weight:normal;margin:revert;padding:revert}tbody,li,p{line-height:1.5em}.mainTOC{border-radius:5px;padding:0.75em 0}.mainTOC details summary{cursor:zoom-in;font-family:var(--font-header);color:var(--dark);font-weight:700}.mainTOC details[open] summary{cursor:zoom-out}#TableOfContents>ol{counter-reset:section;margin-left:0;padding-left:1.5em}#TableOfContents>ol>li{counter-increment:section}#TableOfContents>ol>li>ol{counter-reset:subsection}#TableOfContents>ol>li>ol>li{counter-increment:subsection}#TableOfContents>ol>li>ol>li::marker{content:counter(section) "." counter(subsection) " "}#TableOfContents>ol>li::marker{content:counter(section) " "}#TableOfContents>ol>li::marker,#TableOfContents>ol>li>ol>li::marker{font-family:var(--font-body);font-weight:700}table{border:1px solid var(--outlinegray);width:100%;padding:1.5em;border-collapse:collapse}td,th{padding:0.2em 1em;border:1px solid var(--outlinegray)}img{max-width:100%;border-radius:3px;margin:1em 0}p>img+em{display:block;transform:translateY(-1em)}sup{line-height:0}blockquote{margin-left:0;border-left:3px solid var(--secondary);padding-left:1em;transition:border-color 0.2s ease}.footnotes p{margin:0.5em 0}.pagination{list-style:none;padding-left:0;display:flex;margin-top:2em;gap:1.5em;justify-content:center}.pagination .disabled{opacity:0.2}.pagination>li{text-align:center;display:inline-block}.pagination>li a{background-color:transparent !important}.pagination>li a[href$="#"],.pagination>li.active a{opacity:0.2}article>h1{margin-top:2em;font-size:2em}article>.meta{margin:0 0 1em 0;opacity:0.7}article a{font-weight:600}article a.internal-link{text-decoration:none;background-color:rgba(143,159,169,0.15);padding:0 0.1em;margin:auto -0.1em;border-radius:3px}article a.internal-link.broken{opacity:0.5;background-color:transparent}article p{overflow-wrap:anywhere}.tags{list-style:none;padding-left:0}.tags .meta{margin:1.5em 0}.tags .meta>h1{margin:0}.tags .meta>p{margin:0}.tags>li{display:inline-block;margin:0.4em 0.2em}.tags>li>a{border-radius:8px;border:var(--outlinegray) 1px solid;padding:0.2em 0.5em}.tags>li>a::before{content:"#";margin-right:0.3em;color:var(--outlinegray)}.backlinks a{font-weight:600;font-size:0.9rem}sup>a{text-decoration:none;padding:0 0.1em 0 0.2em}#page-title{margin:0}#page-title>a{font-family:var(--font-header)}a{font-size:1em;font-weight:700;text-decoration:none;transition:all 0.2s ease;color:var(--secondary)}a:hover{color:var(--tertiary) !important}pre{font-family:var(--font-mono);padding:0.75em;border-radius:3px;overflow-x:scroll}code{font-family:var(--font-mono);font-size:0.85em;padding:0.15em 0.3em;border-radius:5px;background:var(--lightgray)}@keyframes fadeIn{0%{opacity:0}100%{opacity:1}}footer{margin-top:4em;text-align:center}footer ul{padding-left:0}hr{width:100%;margin:2em auto;height:1px;border:none;background-color:var(--outlinegray)}.page-end{display:flex;flex-direction:row;gap:2em}@media all and (max-width: 780px){.page-end{flex-direction:column}}.page-end>*{flex:1 0 0}.page-end>.backlinks-container>ul{list-style:none;padding:0;margin:0}.page-end>.backlinks-container>ul>li{margin:0.5em 0;padding:0.25em 1em;border:var(--outlinegray) 1px solid;border-radius:5px}.page-end #graph-container{border:var(--outlinegray) 1px solid;border-radius:5px;box-sizing:border-box;min-height:250px;margin:0.5em 0}.page-end #graph-container>svg{margin-bottom:-5px}.centered{margin-top:30vh}.spacer{flex:1 1 auto}header,.menu-search{display:flex;flex-direction:row;align-items:center;margin:2em 1em 2em}header>h1,.menu-search>h1{font-size:2em}@media all and (max-width: 600px){header>nav,.menu-search>nav{display:none}}header #search-icon,.menu-search #search-icon{background-color:var(--lightgray);border-radius:4px;height:2em;display:flex;align-items:center;cursor:pointer}header #search-icon>p,.menu-search #search-icon>p{display:inline;padding:0 1.5em 0 2em}header svg,.menu-search svg{cursor:pointer;width:18px;min-width:18px;margin:0 0.5em}header svg:hover .search-path,.menu-search svg:hover .search-path{stroke:var(--tertiary)}header svg .search-path,.menu-search svg .search-path{stroke:var(--gray);stroke-width:2px;transition:stroke 0.5s ease}#search-container{position:fixed;z-index:9999;left:0;top:0;width:100vw;height:100%;overflow:scroll;display:none;backdrop-filter:blur(4px);-webkit-backdrop-filter:blur(4px)}#search-container>div{width:50%;margin-top:15vh;margin-left:auto;margin-right:auto}@media all and (max-width: 1200px){#search-container>div{width:90%}}#search-container>div>*{width:100%;border-radius:4px;background:var(--light);box-shadow:0 14px 50px rgba(27,33,48,0.12),0 10px 30px rgba(27,33,48,0.16);margin-bottom:2em}#search-container>div>input{box-sizing:border-box;padding:0.5em 1em;font-family:var(--font-body);color:var(--dark);font-size:1.1em;border:1px solid var(--outlinegray)}#search-container>div>input:focus{outline:none}#search-container>div>#results-container .result-card{padding:1em;cursor:pointer;transition:background 0.2s ease;border:1px solid var(--outlinegray);border-bottom:none;width:100%;font-family:inherit;font-size:100%;line-height:1.15;margin:0;overflow:visible;text-transform:none;text-align:left;background:var(--light);outline:none}#search-container>div>#results-container .result-card:hover,#search-container>div>#results-container .result-card:focus{background:rgba(180,180,180,0.15)}#search-container>div>#results-container .result-card:first-of-type{border-top-left-radius:5px;border-top-right-radius:5px}#search-container>div>#results-container .result-card:last-of-type{border-bottom-left-radius:5px;border-bottom-right-radius:5px;border-bottom:1px solid var(--outlinegray)}#search-container>div>#results-container .result-card>h3,#search-container>div>#results-container .result-card>p{margin:0}.search-highlight{background-color:#afbfc966;padding:0.05em 0.2em;border-radius:3px}.section-ul{list-style:none;margin-top:2em;padding-left:0}.section-li{margin-bottom:1em}.section-li>.section{display:flex;align-items:center}@media all and (max-width: 600px){.section-li>.section .tags{display:none}}.section-li>.section h3>a{font-weight:700;margin:0}.section-li>.section p{margin:0;padding-right:1em;flex-basis:6em}.section-li h3{opacity:1;font-weight:700;margin:0}.section-li .meta{opacity:0.6}@keyframes dropin{0%{display:none;opacity:0;visibility:hidden}1%{display:inline-block;opacity:0}100%{opacity:1;visibility:visible}}.popover{z-index:999;position:absolute;width:20rem;display:none;background-color:var(--light);padding:1rem;margin:1rem;border:1px solid var(--outlinegray);border-radius:5px;pointer-events:none;transition:opacity 0.2s ease, transform 0.2s ease;user-select:none;overflow-wrap:anywhere;box-shadow:6px 6px 36px 0 rgba(0,0,0,0.25)}@media all and (max-width: 600px){.popover{display:none !important}}.popover.visible{opacity:1;visibility:visible;display:inline-block;animation:dropin 0.2s ease}.popover>h3{font-size:1rem;margin:0.25rem 0}.popover .meta{margin-top:0.25rem;opacity:0.5;font-family:var(--font-mono);font-size:0.8rem}.popover>p{margin:0;padding:0.5rem 0}.popover>p,.popover>a{font-size:1rem;font-weight:400;user-select:none}#contact_buttons ul{list-style-type:none}#contact_buttons ul li{display:inline-block}#contact_buttons ul li a{padding:0 1em}mark{background-color:var(--highlighted);color:var(--gray)} diff --git a/resources/_gen/assets/scss/quartz/styles/custom.scss_0ccffbd39a5ea808aa33646cb7c2a662.content b/resources/_gen/assets/scss/quartz/styles/custom.scss_0ccffbd39a5ea808aa33646cb7c2a662.content index d173f9b..e69de29 100644 --- a/resources/_gen/assets/scss/quartz/styles/custom.scss_0ccffbd39a5ea808aa33646cb7c2a662.content +++ b/resources/_gen/assets/scss/quartz/styles/custom.scss_0ccffbd39a5ea808aa33646cb7c2a662.content @@ -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} diff --git a/static/linkmap b/static/linkmap index 4032307..db7eb8d 100644 --- a/static/linkmap +++ b/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/