diff --git a/.gitattributes b/.gitattributes index 6313b56c5..bd9ff6169 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,78 @@ +# Apply override to all files in the directory +*.md linguist-detectable + +# Auto detect text files and perform LF normalization * text=auto eol=lf + +# The above will handle all files NOT found below +# Documents +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain +*.md text diff=markdown +*.mdx text diff=markdown +*.tex text diff=tex +*.adoc text +*.csv text +*.txt text +*.sql text +*.epub diff=astextplain + +# Graphics +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.tif binary +*.tiff binary +*.ico binary +# SVG treated as text by default. +*.svg binary +# If you want to treat it as binary, +# use the following line instead. +# *.svg text +*.eps binary + +# Scripts +*.bash text eol=lf +*.sh text eol=lf +# These are explicitly windows files and should use crlf +*.bat text eol=crlf +*.cmd text eol=crlf +*.ps1 text eol=crlf + +# Serialisation +*.json text +*.toml text +*.xml text +*.yaml text +*.yml text + +# Archives +*.7z binary +*.gz binary +*.tar binary +*.tgz binary +*.zip binary + +# Text files where line endings should be preserved +*.patch -text + +# Lua Source files +*.lua text + +# Luadoc output +*.html text diff=html +*.css text diff=css + +# Exclude files from exporting +.gitattributes export-ignore +.gitignore export-ignore +.gitkeep export-ignore \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 40b2d4a3a..000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1 +0,0 @@ -github: [jackyzha0] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7f1576df4..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Something about Quartz isn't working the way you expect -title: "" -labels: bug -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e766b49b8..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea or improvement for Quartz -title: "" -labels: enhancement -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..24755792d --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,29 @@ +name: Build only + +on: + workflow_dispatch: + pull_request: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 # Fetch all history for git info + - uses: actions/setup-node@v3 + with: + node-version: 18 + - name: Install Dependencies + run: npm ci + - name: Build Quartz + run: npx quartz build \ No newline at end of file diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index 8915143c4..000000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,47 +0,0 @@ -name: Build and Test - -on: - pull_request: - branches: - - v4 - push: - branches: - - v4 - -jobs: - build-and-test: - if: ${{ github.repository == 'jackyzha0/quartz' }} - strategy: - matrix: - os: [windows-latest, macos-latest, ubuntu-latest] - runs-on: ${{ matrix.os }} - permissions: - contents: write - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Setup Node - uses: actions/setup-node@v3 - with: - node-version: 18 - - - name: Cache dependencies - uses: actions/cache@v3 - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - - run: npm ci - - - name: Check types and style - run: npm run check - - - name: Test - run: npm test - - - name: Ensure Quartz builds, check bundle info - run: npx quartz build --bundleInfo diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 000000000..7af6a20f7 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,46 @@ +name: Build and Deploy to GitHub Pages + +on: + workflow_dispatch: + # push: + # branches: + # - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 # Fetch all history for git info + - uses: actions/setup-node@v3 + with: + node-version: 18 + - name: Install Dependencies + run: npm ci + - name: Build Quartz + run: npx quartz build + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: public + + deploy: + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 25d07db1c..f58c23fad 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ public prof tsconfig.tsbuildinfo .obsidian +quartz/.quartz-cache .quartz-cache private/ .replit diff --git a/LICENSE.txt b/LICENSE similarity index 96% rename from LICENSE.txt rename to LICENSE index 147e2ca14..ea7d35091 100644 --- a/LICENSE.txt +++ b/LICENSE @@ -1,6 +1,7 @@ MIT License Copyright (c) 2021 jackyzha0 +Copyright (c) 2023 Miguel Pimentel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 4b4731c9b..b0d826746 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ -# Quartz v4 - -> “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming - -Quartz is a set of tools that helps you publish your [digital garden](https://jzhao.xyz/posts/networked-thought) and notes as a website for free. -Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use. - -**If you are looking for Quartz v3, you can find it on the [`hugo` branch](https://github.com/jackyzha0/quartz/tree/hugo).** - -🔗 Read the documentation and get started: https://quartz.jzhao.xyz/ - -[Join the Discord Community](https://discord.gg/cRFFHYye7t) - -## Sponsors - -

- - - +

+ + + + +

+ +# Forgetful Notes + +This repo holds the source code for my digital garden. + +- Based on [Quartz](https://github.com/jackyzha0/quartz/) +- [Documentation](https://quartz.jzhao.xyz/) +- [Join the Discord Community](https://discord.gg/cRFFHYye7t) + +## Useful Commands + +- `npm i` +- `npx quartz update` +- `npx quartz build --serve` +- `npx quartz sync` +- `npx quartz build` +- `npx quartz sync --help` diff --git a/content/.gitkeep b/content/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/content/index.md b/content/index.md new file mode 100644 index 000000000..1b9b4166a --- /dev/null +++ b/content/index.md @@ -0,0 +1,15 @@ +--- +title: Forgetful Notes +description: A digital garden of knowledge. A platform for my learning and creative endeavours. A space for thinking through, building upon, and coming back to. +--- +Hey there! I'm Miguel, and you have come across **Forgetful Notes**—my [[Digital Garden|digital garden]] of knowledge. It serves as a platform for my learning and creative endeavours. A space for thinking through, building upon, and coming back to. + +It is part of my effort to organize my own theories, concepts, and ideas in a more public setting. You will find within a wide range of topics, expanding and exploring ideas across multiple disciplines. In a way, you could say the [[Scope of Work|scope of work]] for the website is not only allowed to, but expected to grow. + +Forgetful Notes embraces the inherent [[Rhizomatic Learning|rhizomatic learning]] and web-like nature of our thinking. It is a living document designed for an audience of one, myself. Like me, all notes contained within should be considered work-in-progress. Expect changes at all content levels. + +That said, I do not let perfectionism get in the way. That means what you read here is not authoritative or complete, and is not representative of my best work. Please keep that in mind as you navigate around the garden. Needless to say, I'm glad you are here. + +* Ready to explore the garden? [[Explore|Let's go!]] +* Want to learn more about me? Check out [[About]]. +* Want to learn more about the site? Check out [[Meta]]. diff --git a/quartz.config.ts b/quartz.config.ts index f677a18f9..24664c767 100644 --- a/quartz.config.ts +++ b/quartz.config.ts @@ -3,13 +3,13 @@ import * as Plugin from "./quartz/plugins" const config: QuartzConfig = { configuration: { - pageTitle: "🪴 Quartz 4.0", + pageTitle: "Forgetful Notes", enableSPA: true, enablePopovers: true, analytics: { provider: "plausible", }, - baseUrl: "quartz.jzhao.xyz", + baseUrl: "forgetful.dev", ignorePatterns: ["private", "templates", ".obsidian"], defaultDateType: "created", theme: { @@ -27,9 +27,10 @@ const config: QuartzConfig = { dark: "#2b2b2b", secondary: "#284b63", tertiary: "#84a59d", - highlight: "rgba(143, 159, 169, 0.15)", + highlight: "rgba(143, 159, 169, 0.15)", // #8f9fa926 }, darkMode: { + // #494f5c #3b3e48 #343a40 light: "#161618", lightgray: "#393639", gray: "#646464", @@ -37,7 +38,7 @@ const config: QuartzConfig = { dark: "#ebebec", secondary: "#7b97aa", tertiary: "#84a59d", - highlight: "rgba(143, 159, 169, 0.15)", + highlight: "rgba(143, 159, 169, 0.15)", // #8f9fa926 }, }, }, diff --git a/quartz.layout.ts b/quartz.layout.ts index 8c1c6c114..53e1f695c 100644 --- a/quartz.layout.ts +++ b/quartz.layout.ts @@ -7,8 +7,11 @@ export const sharedPageComponents: SharedLayout = { header: [], footer: Component.Footer({ links: { - GitHub: "https://github.com/jackyzha0/quartz", - "Discord Community": "https://discord.gg/cRFFHYye7t", + About: "https://miguelpimentel.do/", + Blog: "https://miguelpimentel.do/posts", + Meta: "/Meta", + GitHub: "https://github.com/semanticdata/forgetful-notes/", + Tags: "/tags", }, }), }