百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

用markdown语法制作一个好看的网址导航页面(markdown-web-nav)

zhezhongyun 2025-05-02 22:37 64 浏览

之前为了让谷歌浏览器里的书签放到博客 markdown 文件下,写过一个书签和 markdown 互转的小工具 parse-bookmark,当初也是为了能直接在博客中生成一个网址导航的页面,方便随时查找一些常用的网站。

在公司内部文档中也收集整理了很多网址,直接一行一行地记录或者用个表格记录感觉又不好看,然后就一直想着怎么能生成一个有网站icon、网站名、网站描述这些信息的网址导航页面。

在 markdown 文档中写 html

一般笔记或wiki类的文档网站像confluence、语雀、Notion...本身是支持直接写 markdown 的,很多富文本编辑器也支持 markdown 语法。公司的文档平台也支持 markdown 语法,但是样式只能写成内联样式,为了制作出一个导航页面,之前就写了一段如下的 html 代码直接贴到文档中:

#### 推荐博客
---
<div style="display: flex;align-items: center;flex-wrap: wrap;margin-right: 20px;">
    <a href="https://cafe123.cn" target="_blank" style="display: flex;align-items: center;margin: 0 20px 20px 0;padding: 20px;border-radius: 10px;border: 1px solid #EEE;width:250px;">
        <img src="https://cafe123.cn/logo.svg" style="width:30px;height:30px;border-radius:50%;margin-right:8px;" />
        <span style="white-space:nowrap;overflow:hidden;text-overflow: ellipsis;">cafehaus</span>
    </a>
</div>

按照上面的做法也确实可以生成出一个有模有样的网站导航页面,但是每次想要新加一个网址时都要自己复制一遍 a 标签里的内容来修改,当网址收集多了的时候看着也很乱,每次想新增或者修改一个网址时都要在一堆html标签中寻寻觅觅。

摆脱直接在 markdown 中写 html 代码的困扰

理想的方式应该只用关心网址相关的数据就行了,相同的模板化代码自动生成最好,于是就想到了由网址导航的 json 数据直接给生成需要的网址导航 markdown 内容出来。

但是对于不懂代码的人可能也不知道 json 数据是什么,更不知道要怎么编写修改了。

于是就想到了制作一个可视化的网页工具 markdown-web-nav,让普通用户也可以直接在上面新增编辑网站信息,然后自动生成出来我们需要的 markdown 数据就好了,已实现的功能包括:

  • 可以在网页上新增、编辑、删除需要的网址数据
  • 通过导入json文件直接生成页面数据
  • 实时预览最终的markdown渲染的网址导航效果
  • 一键自动复制最终的markdown数据
  • 导出页面数据到markdown文件、json文件
  • 可记录最近的历史修改记录,方便回滚修改

使用 markdown-web-nav 工具制作网址导航页面步骤

制作出一个网址导航页面总共分为如下6个步骤,操作也很简单:

1、打开 markdown-web-nav 网页工具

在浏览器中打开:
https://cafehaus.github.io/markdown-web-nav

网站内容区左侧为级联网址数据管理区,可以在这里编辑新增、编辑、删除需要的网址数据。右侧为效果预览区,当我们修改了网址数据后,可以在这里实时查看到用markdown渲染出来一样的最终效果。

2、上传json网址数据文件(可选)

对于程序员用户,可能更加习惯编写一份 json 数据,编写好后点击“上传json网址数据文件”按钮可直接上传数据,此时左侧数据和右侧预览效果都会自动边城 json 文件中对应的数据。

注意编写 json 数据时按按照特定的格式,对于导航分类必须设置 title,对于分类下的网站可以通过 name、url、icon、description 分别设置对应的信息,具体格式可参照“下载示例模板”中的 json 文件。

{
  "root": [
    {
      "title": " 精选博客",
      "children": [
        {
          "name": "咖啡教室",
          "url": "https://cafe123.cn",
          "description": "就想开间小小咖啡馆,做做咖啡调调酒",
          "icon": "https://cafe123.cn/logo.svg"
        }
      ]
    },
    {
      "title": "   AI工具",
      "children": [
        {
          "name": "DeepSeek",
          "url": "https://chat.deepseek.com",
          "description": "我是 DeepSeek,很高兴见到你!",
          "icon": "https://chat.deepseek.com/favicon.svg"
        }
      ]
    }
  ]
}

当然,对于不习惯 json 模式的用户可以直接跳过此步骤,参考下面的第3步。

3、新增导航分类

网址导航中的网站数据我们一般会进行分类,比如科技的放一块、美食的放一块...这里我们也需要先创建一个导航分类,在新增一个分类的同时我们需要同步添加一个网站导航数据。

4、新增网站数据

添加好导航分类后我们就可以在分类下面添加网站数据了,直接点击左侧分类信息后面的号图标,可以在弹窗中填写具体的网站信息,其中网站名称和网站地址必填。

为了更加有辨识度和美观建议网站图标地址也填写上,如果不填写默认会用网站名称的第一个字符生成一个默认的圆形文字图标,对于不知道怎么获取网站对应图标的可以参考后面的常见文题章节。

进入网页后默认有几个示例数据,可以直接在示例的基础上修改、新增。点击分类和网站数据后面的编辑图标可以编辑详细信息,点击减号图标可以删除当前元素,点击分加号图标可以新增当前分类下的网站信息。

5、复制 markdown 数据

数据添加完成后,可以点击右侧的“复制markdown数据”,直接将最终的markdown数据复制到粘贴板上。同时如果每次修改比较大时也建议点击“导出json“按钮备份一下,可将当前数据导出为一个json文件保存在自己电脑上,下次想再次修改时可以直接通过“上传json网址数据文件”加载回来之前的所有数据。

6、粘贴到支持markdown内容渲染的文档页面中

上一步复制好markdown数据后,我们就可以在支持markdown渲染的文档中或者编辑器中粘贴进去。

如果想自己本地修改markdown数据,也可以直接选择“导出markdown”下载到本地再进行修改。

常见问题

1、如何还原之前的数据?

制作好网址导航后,如果过了一段时间想要再次新增时,直接打开网站工具
https://cafehaus.github.io/markdown-web-nav 后如何能加载回来之前的数据?

有两种方式:第一种通过事先下载好之前的json备份文件,再通过“上传json网址数据文件”可以加载回之前的数据。

第二种可以通过顶部的“修改历史”按钮选择之前的某个时间点的版本进行还原,可以鼠标放到顶部的“修改历史”按钮上,里面会记录我们最近的一些修改记录,点击某个修改时间可以加载对应时间点的修改数据,不过操作前建议先点“导出json”按钮将当前的数据备份到自己电脑本地,以防数据丢失。

第二种通过修改历史找回比较反汇编简单,不过依然建议大家每次同时下载 json 文件备份,因为修改历史记录有可能会存在数据丢失的问题。

2、如何找到某个网站的 icon 图标链接?

大多网站使用的的图标就是在域名后面跟上如下的一些后缀:

  • /favicon.ico
  • /logo.png
  • /logo.svg
  • /images/logo.png

可以自己在浏览器中网址后面加上上面的后缀测试看能不能正常打开图片,如果打开失败也可以换后面一种办法。

在浏览器中打开我们需要的网址后,鼠标右键-检查(快捷键F12),会自动打开浏览器调试台,然后选到 network 后再刷新一下,浏览器会再次加载当前页面的所有资源,里面会有各种html、js、css、图片这些资源,然后从这些资源中去找到我们需要的图标,一般以 logo、favicon 这些命名,找到后再鼠标右键-Open in new tab,会自动在浏览器中打开,最后复制出来打开的浏览器页面地址。

3、如何反馈问题?

有任何使用问题或建议可以在 github 对应仓库提 issue:
https://github.com/cafehaus/markdown-web-nav/issues

希望此工具能给大家带来帮助,有任何建议也欢迎大家积极反馈。

相关推荐

Python入门学习记录之一:变量_python怎么用变量

写这个,主要是对自己学习python知识的一个总结,也是加深自己的印象。变量(英文:variable),也叫标识符。在python中,变量的命名规则有以下三点:>变量名只能包含字母、数字和下划线...

python变量命名规则——来自小白的总结

python是一个动态编译类编程语言,所以程序在运行前不需要如C语言的先行编译动作,因此也只有在程序运行过程中才能发现程序的问题。基于此,python的变量就有一定的命名规范。python作为当前热门...

Python入门学习教程:第 2 章 变量与数据类型

2.1什么是变量?在编程中,变量就像一个存放数据的容器,它可以存储各种信息,并且这些信息可以被读取和修改。想象一下,变量就如同我们生活中的盒子,你可以把东西放进去,也可以随时拿出来看看,甚至可以换成...

绘制学术论文中的“三线表”具体指导

在科研过程中,大家用到最多的可能就是“三线表”。“三线表”,一般主要由三条横线构成,当然在变量名栏里也可以拆分单元格,出现更多的线。更重要的是,“三线表”也是一种数据记录规范,以“三线表”形式记录的数...

Python基础语法知识--变量和数据类型

学习Python中的变量和数据类型至关重要,因为它们构成了Python编程的基石。以下是帮助您了解Python中的变量和数据类型的分步指南:1.变量:变量在Python中用于存储数据值。它们充...

一文搞懂 Python 中的所有标点符号

反引号`无任何作用。传说Python3中它被移除是因为和单引号字符'太相似。波浪号~(按位取反符号)~被称为取反或补码运算符。它放在我们想要取反的对象前面。如果放在一个整数n...

Python变量类型和运算符_python中变量的含义

别再被小名词坑哭了:Python新手常犯的那些隐蔽错误,我用同事的真实bug拆给你看我记得有一次和同事张姐一起追查一个看似随机崩溃的脚本,最后发现罪魁祸首竟然是她把变量命名成了list。说实话...

从零开始:深入剖析 Spring Boot3 中配置文件的加载顺序

在当今的互联网软件开发领域,SpringBoot无疑是最为热门和广泛应用的框架之一。它以其强大的功能、便捷的开发体验,极大地提升了开发效率,成为众多开发者构建Web应用程序的首选。而在Spr...

Python中下划线 ‘_’ 的用法,你知道几种

Python中下划线()是一个有特殊含义和用途的符号,它可以用来表示以下几种情况:1在解释器中,下划线(_)表示上一个表达式的值,可以用来进行快速计算或测试。例如:>>>2+...

解锁Shell编程:变量_shell $变量

引言:开启Shell编程大门Shell作为用户与Linux内核之间的桥梁,为我们提供了强大的命令行交互方式。它不仅能执行简单的文件操作、进程管理,还能通过编写脚本实现复杂的自动化任务。无论是...

一文学会Python的变量命名规则!_python的变量命名有哪些要求

目录1.变量的命名原则3.内置函数尽量不要做变量4.删除变量和垃圾回收机制5.结语1.变量的命名原则①由英文字母、_(下划线)、或中文开头②变量名称只能由英文字母、数字、下画线或中文字所组成。③英文字...

更可靠的Rust-语法篇-区分语句/表达式,略览if/loop/while/for

src/main.rs://函数定义fnadd(a:i32,b:i32)->i32{a+b//末尾表达式}fnmain(){leta:i3...

C++第五课:变量的命名规则_c++中变量的命名规则

变量的命名不是想怎么起就怎么起的,而是有一套固定的规则的。具体规则:1.名字要合法:变量名必须是由字母、数字或下划线组成。例如:a,a1,a_1。2.开头不能是数字。例如:可以a1,但不能起1a。3....

Rust编程-核心篇-不安全编程_rust安全性

Unsafe的必要性Rust的所有权系统和类型系统为我们提供了强大的安全保障,但在某些情况下,我们需要突破这些限制来:与C代码交互实现底层系统编程优化性能关键代码实现某些编译器无法验证的安全操作Rus...

探秘 Python 内存管理:背后的神奇机制

在编程的世界里,内存管理就如同幕后的精密操控者,确保程序的高效运行。Python作为一种广泛使用的编程语言,其内存管理机制既巧妙又复杂,为开发者们提供了便利的同时,也展现了强大的底层控制能力。一、P...