Giter VIP home page Giter VIP logo

gatsby-theme-andy's Introduction

gatsby-theme-andy

theme andy logo
npm

This is inspired by the work of Andy and is based on gatsby-theme-brain. Also uses react-stacked-pages-hook for staking up the notes side by side.

Simple Demo - https://codesandbox.io/s/gatsby-theme-andy-demo-tnv6r

https://notes.aravindballa.com uses this with a few custom components.

Usage

  • Create a new Gatsby project
  • yarn add gatsby-theme-andy
  • Add gatsby-theme-andy to plugins in gatsby-config.js. Add a title in siteMetadata in your config.
  • Create directory content at root and add md files.
  • gatsby develop

Configuration

All the plugin options valid for gatsby-theme-brain can be given to this theme as well.

You can shadow/override few componenets in your project. In your directory, you would need to place them at ./gatsby-theme-andy/src/components. Have a look at the default components to see what props they get. Components you can override -

  • Popover.js - This is the component which is shown when you hover over an internal link.
  • RefferedBlock.js - The block which contains all the references (Referred in section) to the note. This is at the bottom of the page.
  • BrainNote.js - This is the note page.
  • BrainNoteContainer.js - This is the layout page that stacks up the notes.
  • Tippy.js - This has the TippyJS configs. You'll have to override this if you want to change the props to Tippy.

Contribution

This project is relatively new. Please report issues you face and make PRs by forking the project.

gatsby-theme-andy's People

Contributors

aravindballa avatar aengusmcmillin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.