Skip to content
/ docs Public
forked from Atlas-OS/docs

Atlas documentation hosted on GitHub Pages using MkDocs

Notifications You must be signed in to change notification settings

JXRNO/docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AtlasOS Documentation

Atlas documentation hosted on GitHub Pages using Material for MkDocs.

Here you can help Atlas with documentation, for now we do not have translation capabilities but they will be added in the future.

How to contribute

We recommend for development purposes that you use Conventional Commits with Emojis, you can also use Angular's Conventional Commits Format.

We also recommend that you make a preview build on your own machine for our documentation before you commit, just so that there is no issues with the pull request.

How to make a preview build

As MkDocs uses Python, you will need to have Python and pip installed, we recommend using Scoop or Chocolatey to install these but you can also install via Python's website.

Material for MkDocs has already made a page which you can use for Installation of Material for MkDocs here.

Depending if you installed it locally or via a virtual envioronment, there is already a guide on previewing here

About

Atlas documentation hosted on GitHub Pages using MkDocs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%