{"_id":"@codynhat/gatsby-theme-andy","_rev":"1-fae5f44e549f5b85dfdbb8f40f2fa194","name":"@codynhat/gatsby-theme-andy","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@codynhat/gatsby-theme-andy","version":"0.1.0","description":"A Gatsby theme to build Andy style websites.","main":"index.js","keywords":["gatsby","gatsby-theme","andy","garden","digital garden","second brain","andy matuschak"],"author":{"name":"Cody Hatfield","url":"@codynhat"},"repository":{"url":"git+https://github.com/codynhat/gatsby-theme-andy.git"},"license":"MIT","scripts":{"build":"gatsby build","develop":"gatsby develop","clean":"gatsby clean"},"peerDependencies":{"gatsby":"^2.20.23","react":"^16.13.1","react-dom":"^16.13.1"},"devDependencies":{"@mdx-js/mdx":"^1.6.6","@mdx-js/react":"^1.6.6","gatsby":"^2.24.1","gatsby-plugin-mdx":"^1.2.25","gatsby-transformer-remark":"^2.8.25","react":"^16.13.1","react-dom":"^16.13.1"},"dependencies":{"@aengusm/gatsby-theme-brain":"^1.0.13","@tippyjs/react":"^4.1.0","gatsby-plugin-postcss":"^2.3.11","gatsby-plugin-theme-ui":"^0.3.0","querystring":"^0.2.0","react-helmet":"^6.1.0","react-stacked-pages-hook":"^0.4.4","tailwindcss":"^1.4.6","theme-ui":"^0.3.1"},"gitHead":"faf732b0b31b5722558f9371781f6f0f3a7a4486","bugs":{"url":"https://github.com/codynhat/gatsby-theme-andy/issues"},"homepage":"https://github.com/codynhat/gatsby-theme-andy#readme","_id":"@codynhat/gatsby-theme-andy@0.1.0","_nodeVersion":"14.16.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-ZWaex2ORa5//aRfEnLnaoJTtdcdI+2VM4RZUEtewaBZN7w0UM2QBoPjcgwhN8SuMfsro4TLWk4KqTmCAukjv8Q==","shasum":"58d397983ccb294238bec4859062a724af878c28","tarball":"https://registry.npmjs.org/@codynhat/gatsby-theme-andy/-/gatsby-theme-andy-0.1.0.tgz","fileCount":24,"unpackedSize":55346,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhHsuTCRA9TVsSAnZWagAATv0QAJpjAzeaQ34bjMmgxp2Y\nbhbKQFznPcAG80xJr84VQ8KcqzWpk8s+yhcGhrS2unI2VyA5lOGGyyUd5v0+\nBQ/WHMkrqpyImJpsnfBewG7QfumMALq21v1ZBWsL6XmrZJgZoVdmS8CcWTij\n/hGdodeijJyyjHRkYKZa0WcJt2TbvGRyDCVFCcN5EThtgXwwTK5CCNO3An38\nK9ApP7a0oD58G82MfKxxzV9BXTwOTQ/t4k73FRcE4/DQYtnXfkgm1RZP7hq9\n0ka8vvRqqiU8mYHPJ60yWYkYF/cZDL9mPVtcg/WvzBjgSSgjhUxanWMUI0Fa\nDYPi4wmyTrZJR0IWeCGZ/R0s6L4x11/uyP7FVsa+ltthj2aZInNwqcIH64iG\n+vdbbmaXBkD262AkFVa/IpOdRRlf/JSAXPM74kqmrEmcio/rrTw2OJFwTlPl\n/YHwHyH2HtSRaXhbXcAkWEu0xUuYyX2WKzF9gOEP29IK5AWKkVuDQSYhFEHy\nsm07aQzNwKhgH2qMrFBRP/2+sHoyuIYs4Dmcoy+RQapjpTC0mf2itbT+GLGt\nDpMgWwBnejnZDbkVxGfpnAg0jXK5kUhImbmykmRaSY3h8Lw/JkHpgOCCr7B4\n0wWFlymcat+HIKQ8yD0h4edlhruTgaUA/hns0o1JD6dRQ+/M1ojyW2iDQphB\nwJ/u\r\n=qc0O\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGsON9/aUdPMUQJvczRZ5CVOkMPgG+KohBgsLwu4TtaTAiBUAnFssdbbDWX7RwGO/tChKHtjqnjYne6ebzxCF3CVbQ=="}]},"_npmUser":{"name":"codynhat","email":"cody.hatfield@me.com"},"directories":{},"maintainers":[{"name":"codynhat","email":"cody.hatfield@me.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gatsby-theme-andy_0.1.0_1629408147198_0.2948070798867328"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-19T21:22:27.156Z","0.1.0":"2021-08-19T21:22:27.376Z","modified":"2022-04-05T00:10:18.670Z"},"maintainers":[{"name":"codynhat","email":"cody.hatfield@me.com"}],"description":"A Gatsby theme to build Andy style websites.","homepage":"https://github.com/codynhat/gatsby-theme-andy#readme","keywords":["gatsby","gatsby-theme","andy","garden","digital garden","second brain","andy matuschak"],"repository":{"url":"git+https://github.com/codynhat/gatsby-theme-andy.git"},"author":{"name":"Cody Hatfield","url":"@codynhat"},"bugs":{"url":"https://github.com/codynhat/gatsby-theme-andy/issues"},"license":"MIT","readme":"# gatsby-theme-andy\n\n<p style=\"text-align:center;\" align=\"center\">\n<img src=\"https://github.com/aravindballa/gatsby-theme-andy/raw/master/andy-logo.png\" alt=\"theme andy logo\"  width=\"200\" height=\"auto\"/>\n<br/>\n<img alt=\"npm\" src=\"https://img.shields.io/npm/v/gatsby-theme-andy\">\n</p>\n\nThis is inspired by the work of [Andy](https://notes.andymatuschak.org/About_these_notes) and is based on [gatsby-theme-brain](https://github.com/aengusmcmillin/gatsby-theme-brain). Also uses [react-stacked-pages-hook](https://github.com/mathieudutour/gatsby-n-roamresearch/tree/master/packages/react-stacked-pages-hook) for staking up the notes side by side. And unleashes the power of [theme-ui](https://theme-ui.com/home) for easy themeable components.\n\n[https://notes.aravindballa.com](https://notes.aravindballa.com/) uses this with a few custom components and custom styles.\n\n## Getting started\n\n> ⚠️ This theme requires alteast NodeJS v12. You can check your version by running `node -v` in your terminal. [Know more](https://github.com/aengusmcmillin/gatsby-theme-brain#note-this-theme-requires-nodejs-v12)\n\n### From scratch\n\nVideo tutorial 👇\n\n[![click to watch](https://i.ytimg.com/vi/bf5Wj-1IHa4/hqdefault.jpg)](https://youtu.be/bf5Wj-1IHa4)\n\n_Link to the [video](https://youtu.be/bf5Wj-1IHa4)_\n\n- Create a new directory and from that directory, run `npm init`.\n- Add all the dependencies `yarn add gatsby react react-dom gatsby-theme-andy`.\n- Create a file `gatsby-config.js`. Now we add `gatsby-theme-andy` to plugins and a `title` in `siteMetadata` in that config.\n\n  ```js\n  module.exports = {\n    siteMetadata: {\n      title: 'My Notes',\n    },\n    plugins: [`gatsby-theme-andy`],\n  };\n  ```\n\n- Create directory `content` at root and add a few `md` files. We can use `[[]]` syntax to interlink the pages. Look at [this directory](./sample-content) for an example.\n- Now we add these scripts below to `package.json` and run `yarn develop`.\n\n  ```json\n  \"scripts\": {\n    \"build\": \"gatsby build\",\n    \"develop\": \"gatsby develop\",\n    \"clean\": \"gatsby clean\"\n  },\n  ```\n\n### Adding to an exsisting Gatsby project\n\n> _Detailed steps coming soon_\n\n## Configuration\n\nAll the plugin options valid for [gatsby-theme-brain](https://github.com/aengusmcmillin/gatsby-theme-brain) can be given to this theme as well. Other than those, we have\n\n| Option                       | Default Value | Description                                                    |\n| ---------------------------- | ------------- | -------------------------------------------------------------- |\n| `themeUIOtherwiseConfigured` | `false`       | Enable this if you have already setup theme-ui in your project |\n\n### Configuring the theme\n\nThis project uses `theme-ui` which allows us to easily theme the site. You can customize the theme by adding a file at `.src/gatsby-theme-andy/theme.js`. The default values for the theme are at [src/theme.js](./src/theme.js). You can copy these to the new file you created and edit the values as you wish. 😎\n\n<!-- TODO add example from notes.aravindballa.com after updating it -->\n\n### Shadowing components\n\nYou can shadow/override a few components for increased customizability. In your project, you would need to place them at `./src/gatsby-theme-andy/components/`. ⚡️Have a look at the default components to see what `props` they get. Components you can override -\n\n| Component                                                       | Description                                                                                                                                                                               |\n| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [BrainNote.js](./src/components/BrainNote.js)                   | This is the note page and it is responsible for collecting all the popups and passing them to the `MdxComponents.js`. It's really a cool way of doing it.                                 |\n| [BrainNoteContainer.js](./src/components/BrainNoteContainer.js) | This is the layout page that stacks up the notes side by side.                                                                                                                            |\n| [Popover.js](./src/components/Popover.js)                       | The component that pops up when you hover over an internal link.                                                                                                                          |\n| [Header.js](./src/components/Header.js)                         | The top bar of the website. If you just want to change the text, you can do it in `gatsby-config.js -> siteMetadata -> title`.                                                            |\n| [Footer.js](./src/components/Footer.js)                         | Footer that contains the `ReferredBlock` as well as the message at the bottom of the note.                                                                                                |\n| [RefererdBlock.js](./src/components/ReferredBlock.js)           | The block which contains all the references (Referred in section) to the note.                                                                                                            |\n| [Tippy.js](./src/components/Tippy.js)                           | This has the TippyJS configs. You can configure things like the [hover animations](https://atomiks.github.io/tippyjs/v6/animations/) here. Remember to change the css import as well.     |\n| [MdxComponents.js](./src/components/MdxComponents.js)           | This has a custom component `AnchorTag` which gets the popover as a prop and displays it when we hover over an internal link. If you wish to add extra MDX components, this is the place! |\n\n## Contribution\n\nThis project is relatively new. Please report issues you face and yes, I'd be happy to accept PRs. 😉\n","readmeFilename":"readme.md"}