Giter Club home page Giter Club logo

docs-1's Introduction

pyroscope.io

This is source code for pyroscope.io website. It's based on docusaurus.

Installation

To install dependencies run this command. Make sure you have yarn installed before continuing.

yarn install

Local development

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server:

yarn start

Contributing

Feel free to contribute to the project by forking the repository and submitting pull requests.

Changing Docusaurus Components

Sometimes you might want to change a docusaurus component (for example, Footer). To do that you'll need to copy the component from docusaurus. This process is callsed swizzling and here's the best way to do it:

yarn run swizzle <theme name> [component name]
# for example:
yarn run swizzle @docusaurus/theme-classic Footer

You can learn more about swizzling in docusaurus docs.

Upgrading Docusaurus

The biggest thing you need to keep in mind is that all components that were updated manually (swizzled) have to be updated as well.

Syncing videos (requires AWS permissions)

aws s3 sync s3://pyroscope.io/videos ./static/videos

docs-1's People

Contributors

6fears7 avatar abeaumont avatar awethon avatar camilogarcialarotta avatar cyhii avatar dannykopping avatar deejgregor avatar eh-am avatar ekpatrice avatar gorvgoyl avatar jacobtaylor-roblox avatar jun10ng avatar kolesnikovae avatar korniltsev avatar ljfreelancer88 avatar omarabid avatar pavelpashkovsky avatar petethepig avatar pyroscopebot avatar rperry2174 avatar sfwn avatar shaleynikov avatar shanson7 avatar stevekrouse avatar thisisobate avatar yazino12 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.