Giter VIP home page Giter VIP logo

docs's Introduction

Local development setup

MacOS

  • Install homebrew (https://brew.sh/)
  • Install node and npm
  • Git clone this repository ([email protected]:planetscale/docs.planetscale.com.git)
  • Switch to repository's folder
  • Install package dependencies with npm install
  • Execute npx next dev or npm run dev to start a local nextJS server
  • Access development server at http://localhost:3000. 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 and (optionally) a subtitle and/or banner for the page.
  • When creating a new document, also create a corresponding entry in meta.json to define the category and position of the document's link in the navigation list.

Notes

  • Search is powered by DocSearch. The PlanetScale 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

antibland avatar avaidyanatha avatar ayrton avatar bmorrisondev avatar bnlandry avatar dbussink avatar dependabot[bot] avatar dkhenry avatar fooforge avatar gedgar avatar github-actions[bot] avatar hallaroo avatar hollylawly avatar iheanyi avatar jamesqquick avatar jasonlong avatar jbbelcher53 avatar jgreet avatar johnyerhot avatar jtcunning avatar lkburns avatar mscoutermarsh avatar nickvanw avatar orware avatar pixeljanitor avatar pritianka avatar raunaqgupta avatar reimertz avatar skullface avatar tbarn 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.