EzeKoren/theeye-docs

theeye example and documentation

Static site for documentation

If you are looking for our documentation please refer to https://documentation.theeye.io

What is this repo?

A static web page (sometimes called a flat page or a stationary page) is a web page that is delivered to the user's web browser exactly as stored,[1] in contrast to dynamic web pages which are generated by a web application.[2]

Consequently, a static web page displays the same information for all users, from all contexts, subject to modern capabilities of a web server to negotiate content-type or language of the document where such versions are available and the server is configured to do so.

Python: MkDocs

• site: https://github.com/mkdocs/mkdocs/
  • last commit: 2019-m05
• template: https://github.com/squidfunk/mkdocs-material
  • last commit: 2019-m06

step by step:

tree projects

theeye-docs
  ├── docs                ---> files 
  │   └── imagenes        ---> assets
  ├── mkdocs.yml          ---> mkdocs, yml, builds the documentation site itself
  ├── Pipfile             ---> python mkdocs
  ├── Pipfile.lock        ---> python mkdocs
  ├── README.md           ---> This is file you are reading right now.
  └── site                ---> the static site ready for publishing
  └── Dockerfile          ---> docker enviroment for building the static site

Docker enviroment

Start development server on http://localhost:8000

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Build sitio estatico

docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

Test sitio estatico

docker run -dit -p 8080:80 -v "$PWD"/site/:/usr/local/apache2/htdocs/ httpd