Giter VIP home page Giter VIP logo

theeye-docs's Introduction

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

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

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.