Skip to content
This repository has been archived by the owner on May 6, 2023. It is now read-only.

Latest commit

 

History

History
183 lines (129 loc) · 5.03 KB

README-en.md

File metadata and controls

183 lines (129 loc) · 5.03 KB

EasyNav

中文文档 | English document

Single Nav Page, Only One File Need To Config

only for noobs~

preview

  • Design for simple home network nav
  • Less files, MIT Licenses, Mod FREE
  • For different levels
    • Noobs
      • modify config.json , maybe add some icons.
      • need basic HTTP service, or just python python -m http.server 8000
    • Geeks
      • replace entire framework，and js template engine.

Document

HowToUse

git clone

git clone https://github.com/dolaCmeo/EasyNav.git

Download & Unzip

https://github.com/dolaCmeo/EasyNav/archive/refs/heads/main.zip

ModifyConfig

Modify config.json

  • Title: page title
  • brandTitle: Inner page title
  • brandLogo: Inner page Logo
  • avatar: User Avatar(DEMO NOT USE)
  • navLinks: Shortcut links
    • linkLabel: Links label
    • items: Links items (Max Lv3)
      • icon: Icon class name (DEMO USED fontawesome)
      • linkName: Link display name
      • linkUri: Link url (when isnull，enable items for subs)
  • navLists: Nav Zone
    • navName: Nav group name
    • apps: Nav apps
      • name: app name(first line)
      • ps: app remark(second line)
      • icon: static app icon assets/icon+<名>+.png
      • addr: app link addr (NOW only first in USED)

Static

Any else icon in need, add to the path by yourself /assets/icon

Deploy

If there is any HTTP service in some folder, Copy & Paste.

If no where could deploy, use Python3，In windows just execute py3_server.bat.

Advanced

FileStructure

  ─┬─
   ├──── index.html                         Main Page
   ├──── config.json                        Config file
   ├──── py3_server.bat                     py3-http win batch 
   ├────┐/assets                            Static
   │    ├───/js                             JavaScript
   │    │      /template-web.min.js         js template
   │    │      /EasyNav.js                  js main code
   │    ├───/css                            css styles
   │    │      /styles.css                  css main code
   │    ├───/icon                           icon images
   │    │      /*.png                       png images
   │    └───/temp                           template for js code
   │           /list.art                    Nav apps template
   │           /link.art                    Shortcut link template
   │           /brand.art                   Inner Title & Logo
   │           /mdfile.art                  Markdown template
   ├─────/pages                             Markdown files
   │        /remark.md                      remark demo md file
   │        /*.md                           md files
   └────┐/vendors                           library
        ├───/jquery-*                       Jquery
        ├───/bootstrap-*                    Bootstrap
        ├───/fontawesome-*                  Fontawesome
        └───/markdown-it-*                  Markdown-it

DIY

For reference only

  1. Coding page, have Left Nav Top Nav Right Bottom Content inside.
  2. Analyze different parts for template
  3. Nav template assets/temp/list.art
  4. Link template assets/temp/link.art
  5. Brand template assets/temp/brand.art
  6. Markdown template assets/temp/mdfile.art
  7. Modify assets/js/EasyNav.js:makeEasyNav() , if you change id uri.
  8. Could use<a href="#!" onclick="showMdDoc()">Show Markdown</a> to getmarkdwonfile display in ContentZone

Copyright

why

  • Make your Config, DONE! No need Backends.
  • Open source，libraries are MIT.
  • I could Add, Modify, Anything U want.
  • Maybe I well add some features, But not for sure.
  • If U get some help, Star PLZ ⭐
  • issues is open, welcome to fork