Docs

screenshot of Docs
gatsby
react
scss

Repository of Twilio SendGrid's product documentation.

Overview:

The SendGrid Documentation repository contains instructions for contributing to the SendGrid documentation website, built with Gatsby. The repository includes information on setting up dependencies and the local repository to make contributions. The project is continuously deployed to production, and contributors are encouraged to submit pull requests to the develop branch.

Features:

  • Local Dependency Setup: Instructions for setting up dependencies on Mac, Windows, and Linux
  • Local Repository Setup: Guidelines for cloning the repository, switching branches, and building the local site
  • Continuous Deployment: The main branch is continuously deployed to production to maintain the latest changes
  • Contributions: Contributors are encouraged to submit pull requests to the develop branch
  • Open Source License: All contributions are made under the MIT License
  • Developer Experience Team: The project is guided and supported by the SendGrid Developer Experience Team
  • Familiarize with Styleguide: Contributors are advised to familiarize themselves with the project's styleguide

Local Dependency Setup:

Mac:

  1. Install Git for Mac using Homebrew: brew install git
  2. Set your Node.js version to 12
  3. Install npm

Windows:

gatsby
Gatsby

GatsbyJS is a free and open-source static site generator based on React. It uses a modern development stack including Webpack, GraphQL, and modern JavaScript and CSS frameworks. It also provides a rich set of plugins, starters, and themes.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

scss
SCSS

SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.

documentation
Documentation

Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.

algolia
Algolia

Algolia is a search engine API that enables developers to integrate lightning-fast search functionality into their websites and applications. It features extensive documentation, powerful query options, and a user-friendly dashboard for managing and monitoring search performance.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

Formspree

A website that uses Formspree for form management to enable seamless form submissions and handling. This includes features such as email notifications, custom form handling, and spam protection to ensure a smooth and secure form submission process.

github-pages
GitHub Pages

Gridsome is a Vue.js-based static site generator that makes it easy to build fast and flexible websites and applications by leveraging modern web technologies like GraphQL, Webpack, and hot reloading

prismjs
Prism JS

PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.

Stylelint

Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.