sascha_hemi/pycom-documentation

mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 07:06:20 +01:00

Go to file

oligauc 8eb43d2dd6 Merge pull request #154 from pycom/o_docs

Added Lopy4 FCC/CE certification

2019-10-15 05:17:20 +02:00

Added templates (#111 )

2018-10-28 16:34:21 +00:00

Added Lopy4 CE certification

2019-10-15 05:00:57 +02:00

Bing fallback

2019-08-22 16:30:13 +02:00

static/gitbook/assets

Added Lopy4 CE certification

2019-10-15 05:00:57 +02:00

themes/doc-theme

doc-theme.css: fix scrolltop border effect

2019-07-11 13:28:46 +02:00

.gitignore

chore: added gitignore file

2019-10-04 13:48:23 +02:00

amplify.yml

amplify.yml: force Hugo version

2019-07-09 16:22:40 +02:00

config.toml

docs: added pybytes iOS page

2019-10-04 18:23:04 +02:00

README.md

chore: updated readme

2019-10-03 11:43:06 +02:00

README.md

run locally

brew install hugo
hugo serve

Workflow

Make documentation update

Checkout your branch from master and commit and push your changes
Make a PR against master branch (implicitly set as master branch is our default branch)
Assign a reviewer and let your PR to be merged

Deploy changes

Make PR from master against publish branch
Assign a reviewer and let your PR to be merged
docs were updated

some infos:

assets are in ./static directory, a directory aliased at /
css in /themes/doc-theme/static/doc-theme.css
SUMMARY.md is in config.toml

help

gohugo.io

detect broken links

wget -o 404.txt -r  --spider http://localhost:1313

A webhook has been installed on the publish branch to https://publish.d20i0wkqbblkur.amplifyapp.com/ https://github.com/pycom/pycom-documentation/tree/master