README_en.md · fengyi/nav

<a href="https://nav3.cn/?g">
 <img src="src/assets/logo.png" width="130" />
 </a>
 
 Discovery Navigation
 A purely static, powerful navigation website that supports SEO and online editing, I hope you will like it
 Built-in collection of up to 800+ high-quality websites to help you work, study and live
 
 <a href="README.md">
 <img src="https://img.shields.io/badge/lang-%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-red.svg?longCache=true&style=flat-square">
 </a>
 <img src="https://img.shields.io/github/v/release/xjh22222228/nav" />
 <a href="https://github.com/xjh22222228/nav/stargazers"><img src="https://img.shields.io/github/stars/xjh22222228/nav" alt="Stars"/></a>
 <img alt="Angular" src="https://img.shields.io/static/v1.svg?label=&message=Angular&style=flat-square&color=C82B38">
 <img src="https://img.shields.io/github/license/xjh22222228/nav" />

## Preview

**Domain**

- [https://nav3.cn/](https://nav3.cn/)
- [https://youthful-lamport-a8ada4.netlify.app/](https://youthful-lamport-a8ada4.netlify.app/)
- [https://nav-2siw-git-own-xjh22222228s-projects.vercel.app/](https://nav-2siw-git-own-xjh22222228s-projects.vercel.app/)
- [https://xjh22222228.github.io/nav/](https://xjh22222228.github.io/nav/)

![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/1.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/8.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/3.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/4.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/6.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/9.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/7.png)

## Features

`Discovery Navigation The idea is to make it simple and convenient without relying on back-end services, without complicated configuration and database configuration concepts, so it can be used out of the box.

- 🍰 Built-in 800+utility sites.
- 🍰 Support SEO.
- 🍰 It is completely static and provides automatic deployment functions.
- 🍰 The trigeminal tree has a clear structure and clear classification.
- 🍰 Support one website to associate multiple URLs
- 🍰 The coexistence of beauty and simplicity is no longer the era of killing Matt.
- 🍰 Completely open source, easy to customize.
- 🍰 Support multiple browsing modes and innovation.
- 🍰 Support footprint memory.
- 🍰 Support mobile browsing.
- 🍰 Support search query.
- 🍰 Support custom engine search.
- 🍰 A variety of theme switching.
- 🍰 Support dark mode.
- 🍰 Support background management, no need to deploy.
- 🍰 Support import from Chrome bookmarks

## Deploy

Its as easy as counting numbers "3 2 1" that simple!

#### Method one (github-pages free)

1、Fork the current project.

2、[https://github.com/settings/tokens](https://github.com/settings/tokens) apply for a token, check the corresponding permissions, if you don’t understand, select all, copy and save the token.

3、https://github.com/username/nav/settings/secrets/actions/new Create a new application token, name fill in TOKEN (All are uppercase).

4、Go to https://github.com/username/nav/actions

5、Be sure to modify the project configuration file [nav.config.ts](nav.config.ts)

6、After 5 minutes, open https://username.github.io/nav , you will see a very powerful navigation website.

#### Method 2 (Free Vercel)

The steps are the same as the first method, except that the fourth step is not needed.
For specific use, follow the steps [https://github.com/apps/vercel](https://github.com/apps/vercel)

#### Method 3 (Free Netlify)

[https://www.netlify.com/](https://www.netlify.com/)

## System admin

Modify the routing address to `system`, such as: https://www.nav3.cn/#/light Change to https://www.nav3.cn/#/system

## Bookmark import

Support importing from Chrome bookmarks (WebKit kernel should be supported~), it will automatically detect navigation that meets the three-level classification, and all others will be set as unclassified:

![](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/import.png)

The browser opens chrome://bookmarks/ to export the bookmarks to get the html file, and then import it from the background of the navigation website.

## Upgrade

```bash
git remote add upstream https://github.com/xjh22222228/nav.git
git fetch upstream main
git merge upstream/main --allow-unrelated-histories
git push
```

## Update log

[CHANGELOG](https://github.com/xjh22222228/nav/releases)

## Development and construction

NODE: >= v18

```bash
# Download
git clone --depth=1 https://github.com/xjh22222228/nav.git

cd nav

# Installation dependencies(Node:v18)
yarn

# Start
yarn start

# Build
yarn build
```

## contribute

Thank you for your [contribution](https://github.com/xjh22222228/nav/issues), men.

## Suggest

If you have any functional suggestions, you can initiate an [issue](https://github.com/xjh22222228/nav/issues), Thank you.

## LICENSE

[MIT](./LICENSE)

fengyi/nav

简介

发行版

贡献者

近期动态

fengyi/nav .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

fengyi/nav