Skip to content

MicrosoftDocs/mslearn-create-publish-static-serverless-website

Repository files navigation

page_type languages products description urlFragment
sample
csharp
dotnet
Add 150 character max description
update-this-to-unique-url-stub

Gatsby starter boilerplate

This starter boilerplate gives you Gatsby configuration files that you can use to build your Gatsby website.

How to use this boilerplate

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the hello-world starter.

    # create a new Gatsby site using the the boilerplate
    npx gatsby new my-site https://github.com/MicrosoftDocs/mslearn-create-publish-static-serverless-website 
  2. Start development server.

    Navigate into your new site’s directory and start it up.

    cd my-site/
    npm run develop

    Your site will run at http://localhost:8000.

Contents

File/folder Description
.gitignore Define what to ignore at commit time.
/node_modules This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
/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”.
.gitignore This file tells git which files it should not track / not maintain a version history for.
.prettierrc This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.
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.
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).
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.
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.
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)
README.md A text file containing useful reference information about your project.
LICENSE Gatsby is licensed under the MIT license.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

About

MS Learn sample code repo

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •