Skip to content

Slowist-Lee/navigation

Repository files navigation

Customizable Static Navigation Page

Demo

image

A simple, fast, and highly customizable static navigation page. managed through a single YAML configuration file (navigation.yml).

The final HTML is automatically generated and deployed using a Python script and GitHub Actions.

Configuration Structure

The configuration is written in navigation.yml. Here is a basic overview of the configuration file:

# the logo of the webpage
logo: ./images/logo.svg # fill in the location of the logo in your repository
# banner in the left column
banner: ./images/slowist-logo.jpg # fill in the location of the picture in your repository
# the title of the webpage
page_title: "导航 | Navigation"
# title of the left column
column_title: "Navigation"
# Defines the links in the left-hand sidebar menu
left_column:
  - name: Home
    url: index.html
  - name: Another Page
    url: another.html # You can create more pages and fill in the name here
  - name: Typst
    url: https://typst.app # it can be an outer url either

# Defines the content for the 'index.html' page
# the "index" key become the title of the html page built
# for example: "study"  -> https://navigation.slowist.top/study.html
index:
  # Each item in the list becomes a card with a title.
  # The key ("My Favorite Tools") becomes the card's H2 title.
  - My Favorite Tools:
      # The list of key-value pairs becomes the links.
    - Link Name 1: https://example.com/
    - Link Name 2: https://example.org/
  
  - Another Category:
    - Another Link: https://example.net/

More Customization

  • modifying template.html and main.css for more customization.

To Do

  • Night Apparence.

About

Navigation Page Customized

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors