initial commit

README.md

@@ -1,13 +1,43 @@
-# Introduction
+# local visualization
 
-Welcome to the Pycom documentation site. We recommend reading through all the sections to familiarise yourself with the various tools and features available to you to help you develop on your Pycom module.
+.md files are in the content folder, the theme forlder contains the theme.
 
-To get started, read through the Getting Started guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects.
+install Hugo and run it on the current directory.
+```
+brew install hugo
+hugo serve
+```
 
-* [Products](products.md)
-* [Getting Started](gettingstarted/introduction.md)
-* [Tutorials](tutorials/introduction.md)
-* [Product Info](datasheets/introduction.md)
-* [API Documentation](firmwareapi/introduction.md)
-* [Pybytes](pybytes/introduction.md)
+The file config.toml contains the global .toml
 
+# First generation of publish branch
+
+Some commands that have been used for building:
+
+- ```
+# it clone gh-pages in ./tmp/ and appy all .md files
+./reclone.sh
+# generate toc, title, redirects
+python3 migration.py
+# apply this changes to remove remaining not needed slashes protections
+rpl -R '\)' ')' *
+rpl -R '(' '(' *
+#  use carrefully but there should be not .html in content
+# find "./content/" -name "*.html" -exec rm {} \;
+#  then finally fix link self to images
+rpl -R "gitbook/assets/" "gitbook/assets/" *
+rpl -R "../gitbook/assets" "/gitbook/assets" content
+rpl -R "..//gitbook/assets" "/gitbook/assets" content
+rpl -R "’" "'" content
+rpl -R "✔" "✔" content
+rpl -R "(../" "(/"
+# get the images in static
+cp tmp/pydocs/gitbook/assets/* static/gitbook/assets/
+```
+
+# detect broken links
+
+```
+wget -o 404.txt -r  --spider http://localhost:1313
+cat ~/output.txt | grep -B 7 404 | grep "\-\-20"
+```