https://github.com/free5gc/free5gc.github.io

free5GC official site
https://github.com/free5gc/free5gc.github.io

Last synced: 4 months ago
JSON representation

free5GC official site

• Host: GitHub
• URL: https://github.com/free5gc/free5gc.github.io
• Owner: free5gc
• Created: 2020-12-31T11:10:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-02-14T03:39:58.000Z (4 months ago)
• Last Synced: 2025-02-14T04:28:40.154Z (4 months ago)
• Homepage: https://free5gc.org
• Size: 92.4 MB
• Stars: 7
• Watchers: 2
• Forks: 42
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Support: docs/support/index.md

Awesome Lists containing this project

README

        
# free5GC Website

This repository contains the source code of free5GC's website available at [https://free5gc.org/](https://free5gc.org/)

## Prerequisites

It's required to install the dependencies below:

- pymdown-extensions (mkdocs requirement)

- mkdocs-callouts (mkdocs requirement)

- mkdocs-material (theme)

- For more dependencies, please, check the [requirements](requirements.txt) file

Install the dependencies using the below command

    pip install pymdown-extensions mkdocs-callouts

To install the theme use

    pip install mkdocs-material

[Optional] To load the packages into a Python virtual environment, use the command below

    pip install -r requirements.txt

## Deploying a Development Environment

1. Clone this repository

        git clone https://github.com/free5gc/free5gc.github.io.git

2. Enter the project folder

        cd free5gc.github.io

3. If not already done, install the requirements using

        pip install pymdown-extensions mkdocs-callouts mkdocs-material

    Or (to install the full environment)

    

        pip install -r requirements.txt

4. Deploy an instace of the website

        mkdocs serve

**Note:** If the command is successful, a service should be running on port 5000 on your localhost.

## Using Dev Env

1. Go to the repo folder

2. Deploy the local instance of the website using:

        mkdocs serve

## Other Useful Information

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

### Commands

* `mkdocs serve` - Start the live-reloading docs server.

* `mkdocs build` - Build the documentation site.

* `mkdocs -h` - Print help message and exit.

### Project layout

    mkdocs.yml    # The configuration file.

    ...           # Other webserver related files

    docs/

        index.md  # The documentation homepage.

        ...       # Other markdown pages, images and other files.