Git Product home page Git Product logo

gh-pages-docs's Introduction

A template for using GitHub pages to manage Docs

Using GitHub Actions, this setup achieves:

  • Versioning (eg to have old versions of docs archived)
  • Previews for PRs
  • Managing of concurrent pushes to the Pages branch

See the example docs at https://www.adriangb.com/gh-pages-docs/

gh-pages-docs's People

Contributors

adriangb avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gh-pages-docs's Issues

PR previews should be deleted when PR is closed

Hey there, neat idea for previewing static sites per PR! I was thinking of something similar myself, and you solved it in a nice way. One thing that could be improved is adding some bot or hook to delete PR preview folders on PR closure. Otherwise it seems like the static site would become full of previews. Not sure how to do this off the top of my head, but it seems like something that should be plausible.

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.