Giter VIP home page Giter VIP logo

test-just-the-docs's Introduction

Test Webhook 2

FabOS Documentation Site Template

https://ipamaas.github.io/test-just-the-docs/

Usage

To use the template as starting point for your own documentation site, follow these steps:

  1. Copy "docs" folder to your repository folder
  2. Update _config.yml file with your title, repository url and footer.
  3. Update the index.md file with your repository urls.
  4. Test your site locally following Development Guide below.
  5. Publish your site on Github Pages following Release Guide below.

Development

Preparation

For local development, use VS Code and the "Remote Containers" extension with Docker:

  1. Install VS Code
  2. Install Extension "Remote Containers" (Docker Runtime required!)

Start development container

To develop and test your site inside a container using VS Code, follow these staps:

  1. Type "Ctrl-Shift-P" and enter "Show Remote Menu"
  2. In the "Remote Menu" select "Open Folder in Container ..." and select the "docs" folder
  3. Wait for container created and started for VS Code remote development.
  4. Start Jekyll server by bundle exec jekyll serve --livereload
  5. Open http://localhost:4000

Release on Github Pages

To release the site via Github Pages, follow these steps:

  1. Open the Settings tab of your github repository.
  2. Go to Pages
  3. Enable Github Pages
  4. In Source select your main branch
  5. In Source select the "/docs" folder
  6. Save
  7. Check the Actions tab for build and deploy results.
  8. Open your site at https://<user_or_org_name>.github.io/<repo_name>/

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.