Pure Web Components Documentation

Documentation for Pure Web Components using GatsbyJS and ReactJS. Automatically generates a full documentation PWA for StencilJS built Web Components.

🚀 Quick start

1. Build components.

   Navigate to the project folder and run the StencilJS build process:

   cd pure-web-components/
   yarn build

2. Start developing.

   Navigate to the docs and spin up the GatsbyJS server:

   cd pure-web-components/docs/
   yarn develop

3. Open the source code and start editing!

   Your site is now running at http://localhost:8000!

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Open the pure-web-components/docs/ directory in your code editor of choice and edit src/pages/index.md. Save your changes and the browser will update in real time!

⚙️ How it works

When you run yarn develop it copies over your built web components from the parent folder, then runs gatsby develop (which spins up a Gatsby powered development server).

Gatsby is setup to primarily use Markdown -- either directly from the component folders (the auto-generated Stencil docs) or inside Gatsby's /pages/ directory. Gatsby will create a page for each component that has a Markdown file. And in the pages directory, you can find pages like the site index, or Getting Started guide.

Using Web Components

The Pure Web Components are imported into every Gatsby page, so you can use them in any Markdown, React/JS, or HTML file.

If you use the Markdown syntax for tables, the Markdown compiler will automatically use the Pure Web Component version.

Custom Components

There are also various custom components created to make writing and formatting documentation easier.

• <page-header header={header} subheader={subheader}> - Used for documentation page headings with a large heading and smaller subheader.

These components can be used anywhere in Markdown files, cannot be used in HTML files, or require importing of the component directly in React (e.g. import PageHeader from '../components/pageHeader').

You can create new components by adding them to the Component Docs template that is used to render Markdown pages.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

9. LICENSE: Gatsby is licensed under the MIT license.

10. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

11. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

12. README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

• For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

1. Click Deploy to Netlify
2. Set build path to docs
3. Set build command to npm run build

Doesn't actually work at the moment because Gatsby docs use the /dist/ folder, which isn't included in repo. This requires a build, which means Netlify would have to use the parent Stencil directory, run the build process, then go into the docs folder, install any dependencies, and then finally run the build process. At this point it's easier to just run things locally, verify, and then upload the Gatsby build to Netlify directly. This will be resolved once the pure-web-components package is listed on NPM (or CDN) and Gatsby can use that as a dependency (or Yarn Workspaces for local development of a relative package) instead of the /dist/ folder directly.