Giter Club home page Giter Club logo

docs's Introduction

docs.planetscale.com

CleanShot 2021-07-21 at 16 20 19@2x

Internals

How to setup local development (on MacOS)

  • Install homebrew (https://brew.sh/)
  • Install node and npm
  • Git clone this repository ([email protected]:planetscale/docs.planetscale.com.git)
  • Switch to the repository's folder
  • Install package dependencies with npm install
  • Execute npx next dev or npm run develop to start a local nextJS server
  • Open http://localhost:3000 to access the local server instance. Check terminal to find the actual port being used by your nextJS local server.

How to add a new document

  • All pages in the documentation are markdown (.mdx) files with a frontmatter block on the top. The frontmatter block defines the title of the page.
  • When creating a new page, also create a corresponding entry in meta.json file to define the category and position of the file in the table of contants.

How to add a theme sensitive asset (image)

  • An image can be added with corresponding light and dark equivalents by having two assets: ASSET_NAME_light.png and ASSET_NAME_dark.png.
  • The image link to be used in a .mdx document needs to be the light version of the asset i.e. ASSET_NAME_light.png.

Notes

  • Search is powered by DocSearch. PlanetScale's configuration on DocSearch can be viewed here
  • Sitemap is only generated during a build and is not checked in to the repo.

docs's People

Contributors

raunaqgupta avatar avaidyanatha avatar bnlandry avatar reimertz avatar pritianka avatar antibland avatar lkburns avatar github-actions[bot] avatar dkhenry avatar gedgar avatar deepthi avatar jvaidya avatar hallaroo avatar saifalharthi avatar aquarapid avatar enisoc avatar mataneja avatar mscoutermarsh avatar middlebusher avatar isaacanastasoff avatar teejae avatar y00j avatar sougou avatar ronihe avatar prismaphonic avatar nickvanw avatar jgreet avatar no-itsbackpack avatar alequetzalli avatar

Watchers

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.