Giter Club home page Giter Club logo

documentation's Introduction

Reliably Documentation with Gridsome

This is the Documentation for Reliably, built with Gridsome.

Contribute

Requirements

To contribute to this repository, you should have the following installed:

  • Node 14.* (We'd recommend using nvm to manage Node versions - We include a .nvmrc file to specify the version)

Steps

  1. Install the dependencies with npm install.
  2. Run npx gridsome develop to start a local dev server at http://localhost:8080
  3. Happy coding ๐ŸŽ‰๐Ÿ™Œ

If you wish to contribute to this documentation, please submit a PR with your changes for review.

Notes

Links in Markdown

The standard way to create links in Markdown is as follow: [anchor](/some/documentation/page/).

While this works, it should be used only for external links. This notation is converted to regular links: <a href="/some/documentation/page/">anchor</a> and does not benefits from Gridsome's ability to pre-fetch links.

You should prefer Gridsome's <g-link> component, and use it this way: <g-link to="/some/documentation/page">anchor</g-link>

As a sidenote, it is recommended that if you choose to open an external link in a different tab (which some consider bad practice) with the target="_blank" attribute, you also you the rel="noopener noreferer" attribute. As this attribute is not supported by the Markdown link notation, you should in this case rely on a standard link: <a href="https://example.com" target="_blank" rel="noopener noreferer">Click here!</a>.

documentation's People

Contributors

charliemoon37 avatar ciaransweet avatar daidokoro avatar dmartin35 avatar lawouach avatar mick-roper avatar mperrien avatar reliably-ci avatar xaah 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.