{"id":18265448,"url":"https://github.com/goodbyteco/notebooks","last_synced_at":"2025-04-09T01:43:25.268Z","repository":{"id":65642733,"uuid":"322230141","full_name":"GoodbyteCo/notebooks","owner":"GoodbyteCo","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-02T06:43:16.000Z","size":57140,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T19:55:06.627Z","etag":null,"topics":["archive","astro","fieldnotes","notebook","template","website"],"latest_commit_sha":null,"homepage":"https://goodbyteco.github.io/notebooks/","language":"Astro","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GoodbyteCo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-17T08:31:13.000Z","updated_at":"2023-02-02T05:25:24.000Z","dependencies_parsed_at":"2023-02-17T15:45:18.877Z","dependency_job_id":null,"html_url":"https://github.com/GoodbyteCo/notebooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodbyteCo%2Fnotebooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodbyteCo%2Fnotebooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodbyteCo%2Fnotebooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodbyteCo%2Fnotebooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GoodbyteCo","download_url":"https://codeload.github.com/GoodbyteCo/notebooks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247958710,"owners_count":21024821,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archive","astro","fieldnotes","notebook","template","website"],"created_at":"2024-11-05T11:18:14.386Z","updated_at":"2025-04-09T01:43:25.232Z","avatar_url":"https://github.com/GoodbyteCo.png","language":"Astro","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Personal Notebook Archive\n\nA personal museum of one's past notebooks.\n\n[[Demo](https://goodbyteco.github.io/notebooks)]\n[[Running locally](#running-locally)]\n[[Customizing the site](#customizing-the-site)]\n[[Adding a notebook](#adding-a-notebook)]\n[[Deploying the site](#deploying-the-site)]\n\n\u003cbr\u003e\n\u003cp align=\"middle\"\u003e\n\t\u003cimg\n\t\tsrc=\"./notebooks/assets/homepage-screenshot.png\"\n\t\talt=\"Screen shot of the homepage. 4 notebooks are shown in a grid layout, with the dates they were started and completed listed below.\"\n\t\twidth=\"49%\"\n\t\u003e\n\t\u003cimg\n\t\tsrc=\"./notebooks/assets/notebook-screenshot.png\"\n\t\talt=\"Screen shot of a notebook page. The cover of the notebook is positioned in the center of the page, with information about the notebook listed above.\"\n\t\twidth=\"49%\"\n\t\u003e\n\u003c/p\u003e\n\u003cbr\u003e\n\nThis is a template project for creating a website to view your old notebooks.\nYou can browse [a demo of the site here](https://goodbyteco.github.io/notebooks),\nand hit the \u003ckbd\u003eUse this template\u003c/kbd\u003e button above to create your own.\n\n\n## Running locally\n\nThe project uses the [Bun](https://bun.sh/) package manager and runtime. Install\nit it by running:\n\n```bash\ncurl -fsSL https://bun.sh/install | bash\n\n## or, to install using npm:\nnpm install -g bun\n```\n\nYou can then use the following commands to build and run a local instance of the\nwebsite:\n\n```bash\n## install package dependencies\nbun install\n\n## run development server\nbun run dev\n```\n\nYou should then be able to view the site at http://localhost:3000/notebooks/, and\nrecompile automatically as you make changes.\n\n\n## Customizing the site\n\nFonts, color schemes, and and other miscellaneous style changes can be made in the\n[base.astro](./src/components/base.astro) component (which is applied to every page).\nAlso note that some styling is done in [meta-social-share-image.astro](./src/components/meta-social-share-image.astro)\nto generate the social media URL image previews. \n\n\n## Adding a notebook\n\nTo add a notebook to the archive, create a new folder in the `notebooks` directory.\nName the folder with the date the notebook was started (in YYYY-MM-DD format), the\nlocation it was started in, the date it was completed, and the location it was completed\nin. Use an ascii arrow (\"`--\u003e`\") to separate the start and complete sections, like so:\n\n```bash\n## following this format:\nYYYY-MM-DD \u003clocation\u003e --\u003e YYYY-MM-DD \u003clocation\u003e\n\n## for example:\n2020-12-17 Toronto, ON --\u003e 2023-01-19 Victoria, BC\n```\n\nNow just add the scans of your notebook into the folder. Name each image the page\nnumber, starting on 0 (`00.png`). Make sure to [zero-pad](https://en.wikipedia.org/wiki/Leading_zero)\nthe lower pages so they list out in order.\n\nThe images should be high quality scans, or photographs taken head-on of each page.\nThe notebook should be cut-out of the image, leaving a transparent background. Images\nshould be at least 1600px wide (though too large will cause slow load times).\n\nOnce your images are added, you should create [webp](https://en.wikipedia.org/wiki/WebP)\nand [avif](https://en.wikipedia.org/wiki/AVIF) versions as well. This can be done\nusing an [online image converter](https://convertio.co/png-avif/) or command-line\ntool, such as [ImageMagick](https://imagemagick.org/).\n\n```bash\n## convert all the png files in the current directory to webp and avif using ImageMagick:\nmogrify -format webp *.png \u0026\u0026 mogrify -format avif *.png\n```\n\nOnce you notebook is all set up, run the site locally to make sure everything is in\norder. If you do not think the shininess of the notebook cover is inaccurate, you can\nconfigure the glossiness by adding an additional field to the folder's name: append\n\"` --\u003e x`\" to the end of the name, where `x` is some value between `0` and `1`. There will\nbe no gloss displayed at `0`, and high-gloss displayed at `1`. The default, if unset,\nis `0.15`. For example:\n\n```bash\n2019-11-11 Kingston, ON --\u003e 2020-01-03 Toronto, ON --\u003e 0.3\n```\n\n\n## Deploying the site\n\nThe project includes a [Github Action](https://github.com/features/actions) to deploy\nthe site using Github Pages (see: [deploy.yml](./.github/workflows/deploy.yml)).\nJust activate Github Pages in the repo's **Settings \u003e Pages**, and choose\n**Source: Github Actions**. Make sure the base URL configured in the [Astro config file](./astro.config.mjs)\nmatches the name of the repository.\n\nAlternatively, you can deploy the project to any other platform. See the Astro docs\nfor [guides on deploying your site](https://docs.astro.build/en/guides/deploy/).\n\n\n## Historical\n\nFor an earlier version of this site, see:\n[field-notes-archive.vercel.app](https://field-notes-archive.vercel.app).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoodbyteco%2Fnotebooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoodbyteco%2Fnotebooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoodbyteco%2Fnotebooks/lists"}