Navigation File - BBloggsbott/ProfileServer GitHub Wiki

The navigation file is a yaml file with the following content:

paths:
  - title: "Sample"
    url: "<url>"
    ext: true
  - title: "Sample Nav"
    url: "/somepath/somefile"
    ext: false

Set ext as true if the url is an external url. This file has no effect on the working of the server. It is used only in the response for the base_url.

For example, a request to http://localhost:8080 will have a response:

{
    "profile": {
        "name": "<name>",
        "avatar": "<avatar_url>",
        "bio": "<bio>",
        "location": "<location>",
        "email": "<email_from_profile_file>",
        "social_media": {
            "twitter": "https://twitter.com/<twitter_username>",
            "linkedin": "https://linkedin.com/in/<linkedin_profile_name>",
            "github": "https://github.com/<github_username>",
            "gitlab": "https://gitlab.com/<gitlab_username>"
        }
    },
    "navigation": {
        "paths": [
            {
                "title": "Sample",
                "url": "<url>",
                "ext": true
            },
            {
                "title": "Sample nav",
                "url": "somepath/somefile",
                "ext": false
            }
        ]
    }
}
⚠️ **GitHub.com Fallback** ⚠️