https://github.com/openfaas/docs

Official Docs for OpenFaaS
https://github.com/openfaas/docs

documentation faas openfaas serverless

Last synced: 11 days ago
JSON representation

Official Docs for OpenFaaS

• Host: GitHub
• URL: https://github.com/openfaas/docs
• Owner: openfaas
• License: mit
• Created: 2018-03-21T14:33:37.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-02T17:19:11.000Z (20 days ago)
• Last Synced: 2025-01-02T18:25:21.283Z (19 days ago)
• Topics: documentation, faas, openfaas, serverless
• Language: Makefile
• Homepage: https://docs.openfaas.com/
• Size: 12.7 MB
• Stars: 67
• Watchers: 6
• Forks: 101
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenFaaS docs repository

This is the source repository for the OpenFaaS documentation site.

For local development:

```shell

docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material:latest

```

## Published page

This page is published through the use of `mkdocs` and is hosted on https://netlify.com/ with a TLS cert from LetsEncrypt.

* https://docs.openfaas.com/

All commits into master (or merged PRs) will appear on the front-page after being rebuilt.

## mkdocs-material markdown extensions

There are several markdown extensions that can be used to create special formatting. Look at the docs [here](https://squidfunk.github.io/mkdocs-material/extensions/admonition/) for all available extensions.

## Adding OpenFaaS Users

The list of OpenFaaS users can be found within [docs/index.md](docs/index.md#users-of-openfaas).  Additions to this list should be made while maintaining the alphabetical ordering.