https://github.com/containerssh/containerssh.github.io

The ContainerSSH website
https://github.com/containerssh/containerssh.github.io

containerssh infrastructure mkdocs

Last synced: 16 days ago
JSON representation

The ContainerSSH website

• Host: GitHub
• URL: https://github.com/containerssh/containerssh.github.io
• Owner: ContainerSSH
• License: cc-by-4.0
• Created: 2020-10-23T10:08:11.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-10T07:33:38.000Z (26 days ago)
• Last Synced: 2024-12-10T08:27:46.385Z (26 days ago)
• Topics: containerssh, infrastructure, mkdocs
• Language: Python
• Homepage: https://containerssh.io/
• Size: 40.1 MB
• Stars: 32
• Watchers: 6
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![ContainerSSH - Launch Containers on Demand](https://containerssh.github.io/images/logo-for-embedding.svg)](https://containerssh.github.io/)

The ContainerSSH Website


This repository contains the source code for the ContainerSSH website. It is built using [mkdocs](https://www.mkdocs.org/) and the [material theme](https://squidfunk.github.io/mkdocs-material/).

⚠⚠⚠ Warning: This is a developer documentation. ⚠⚠⚠
The user documentation for ContainerSSH is located at containerssh.io.


## Building and testing the website

In order to build the website you will need [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/). You can install the required dependencies using pip:

```

pip install -r requirements.txt

```

Then you can launch the development server:

```

mkdocs serve

```

This launches the development server on http://localhost:8000/. If it doesn't work, try `python -m mkdocs serve`.