Skip to content

README_EN.md

Latest commit

 

History

History
167 lines (123 loc) · 6.19 KB

README_EN.md

File metadata and controls

167 lines (123 loc) · 6.19 KB


Discovery Navigation

A powerful navigation website that is purely static, supports SEO, and online editing

Built-in collection of 800+ high-quality websites to assist your work, study, and life

简体中文 Stars Angular

Star History Chart

Design Philosophy

No database, no server, zero-cost one-click deployment, ready to use out of the box, yet capable of manipulating and saving data like a database.

Easy to use, simple, and powerful.

Who is using it?

Features

  • 🍰 Built-in 800+ high-quality websites
  • 🍰 Support for Gitee
  • 🍰 Support for GitLab
  • 🍰 Support for importing from browser bookmarks
  • 🍰 Support for exporting data to browser bookmarks
  • 🍰 Support for AI translation
  • 🍰 Support for user submissions, edits, and deletions
  • 🍰 Support for self-deployment (pm2|Docker|BT Panel)/Fork
  • 🍰 Support for category/website movement and references
  • 🍰 Support for SEO search engines
  • 🍰 Support for associating websites with multiple URLs or tags
  • 🍰 Support for detecting website status
  • 🍰 Support for configuring visibility only to yourself
  • 🍰 Support for automatically fetching website icons/names/descriptions
  • 🍰 Support for widget personalization
  • 🍰 Support for dark mode
  • 🍰 Support for backend management without deployment
  • 🍰 Support for footprint memory
  • 🍰 Support for multiple search queries
  • 🍰 Support for custom search engines
  • 🍰 Support for card advertisement display
  • 🍰 Support PWA applications
  • 🍰 Multiple high-value themes to switch between
  • 🍰 Powerful responsive system
  • 🍰 Various loading animations
  • 🍰 Multiple card style designs
  • 🍰 Completely static with automated deployment functionality
  • 🍰 Ternary tree categorization with clear structure and classification

Preview

Preview

Use Cases

  • Deploy internal company navigation system for unified link management
  • Personal bookmark management, browser bookmark alternative
  • Personal navigation website for sharing, value, and discovery

Deployment

Zero-cost deployment, as easy as counting 3-2-1.

gh-pages (Free)

  1. Click Fork in the upper right corner to fork this repository.

  2. Request a token at https://github.com/settings/tokens/new, check repo and workflow permissions, then copy and save the Token.

  3. Open https://github.com/your-username/nav/actions to ensure GitHub Actions are enabled.

  4. Modify the gitRepoUrl field in the root configuration file nav.config.yaml.

  5. Visit https://your-username.github.io/nav to access your powerful navigation site.

If you encounter 404, open https://github.com/your-username/nav/settings/pages and verify if the deployment branch is set to gh-pages.

Netlify (Recommended, Free)

build path dist/browser

https://www.netlify.com/

Vercel (Recommended, Free)

https://github.com/apps/vercel

Cloudflare pages (Recommended, Free)

https://www.cloudflare.com

Configuration

Only need to modify the following fields in the root nav.config.yaml

Fork Self-Deploy Field Description
√ gitRepoUrl Your repository URL
√ branch Deployment branch
√ imageRepoUrl Image repository, default https://github.com/xjh22222228/image?branch=main
√ √ hashMode Whether to use Hash mode for routing, must be true for github pages
√ √ email User submission notification
√ password Self-deployment login password, not needed for Fork users
√ address Self-deployment address
√ mailConfig Email configuration for self-deployment notifications

Backend

Change the route to system to access, e.g., https://www.nav3.cn to https://www.nav3.cn/system

Upgrade

Clone your repository and execute:

git pull
git remote add upstream https://gitee.com/xiejiahe/nav.git
git fetch upstream main
git merge upstream/main --allow-unrelated-histories --no-edit
git push

# If node is installed, just run
npm run update

Support

This project has been maintained and open-sourced since 2018, through numerous iterations and optimizations. It's my honor if this project can help you.

You can buy the author a coffee to keep fighting

LICENSE

For commercial sites, themes, projects, and applications, keep your source code private/proprietary by purchasing a Commercial License .

Licensed under the GNU General Public License 3.0 for compatible open source projects and non-commercial use.

Copyright 2024-present xiejiahe