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

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

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

之前为了让谷歌浏览器里的书签放到博客 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

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

相关推荐

JavaScript中常用数据类型,你知道几个?

本文首发自「慕课网」,想了解更多IT干货内容,程序员圈内热闻,欢迎关注!作者|慕课网精英讲师Lison这篇文章我们了解一下JavaScript中现有的八个数据类型,当然这并不是JavaScr...

踩坑:前端的z-index 之bug一二(zh1es前端)

IE6下浮动元素bug给IE6下的一个div设置元素样式,无论z-index设置多高都不起作用。这种情况发生的条件有三个:1.父标签position属性为relative;2.问题标签无posi...

两栏布局、左边定宽200px、右边自适应如何实现?

一、两栏布局(左定宽,右自动)1.float+margin即固定宽度元素设置float属性为left,自适应元素设置margin属性,margin-left应>=定宽元素宽度。举例:HTM...

前端代码需要这样优化才是一个标准的网站

  网站由前端和后端组成,前端呈现给用户。本文将告诉您前端页面代码的优化,当然仍然是基于seo优化的。  就前端而言,如果做伪静态处理,基本上是普通的html代码,正常情况下,这些页面内容是通过页面模...

网页设计如何自学(初学网页设计)

1在Dreamweaver中搭建不同的页面,需要掌握HTML的语句了,通过调整各项数值就可以制作出排版漂亮的页面,跟着就可以学习一些可视化设计软件。下面介绍网页设计如何自学,希望可以帮助到各位。Dre...

1、数值类型(数值类型有)

1.1数据类型概览MySQL的数据类型可划分为三大类别:数值类型:旨在存储数字(涵盖整型、浮点型、DECIMAL等)。字符串类型:主要用于存储文本(诸如CHAR、VARCHAR之类)。日期/...

网页设计的布局属性(网页设计的布局属性是什么)

布局属性是网站设计中必不可少的一个重要的环节,主要用来设置网页的元素的布局,主要有以下属性。1、float:该属性设置元素的浮动方式,可以取none,left和right等3个值,分别表示不浮动,浮在...

Grid网格布局一种更灵活、更强大的二维布局模型!

当涉及到网页布局时,display:flex;和display:grid;是两个常用的CSS属性,它们都允许创建不同类型的布局,但有着不同的用法和适用场景。使用flex布局的痛点当我们使...

React 项目实践——创建一个聊天机器人

作者:FredrikStrandOseberg转发链接:https://www.freecodecamp.org/news/how-to-build-a-chatbot-with-react/前言...

有趣的 CSS 数学函数(css公式)

前言之前一直在玩three.js,接触了很多数学函数,用它们创造过很多特效。于是我思考:能否在CSS中也用上这些数学函数,但发现CSS目前还没有,据说以后的新规范会纳入,估计也要等很久。然...

web开发之-前端css(5)(css前端设计)

显示控制一个元素的显示方式,我们可以使用display:block;display:inline-block;display:none;其中布局相关的还有两个很重要的属性:display:flex;和...

2024最新升级–前端内功修炼 5大主流布局系统进阶(分享)

获课:keyouit.xyz/14642/1.前端布局的重要性及发展历程前端布局是网页设计和开发的核心技能之一,它决定了页面元素如何组织和呈现。从早期的静态布局到现代的响应式布局,前端布局技术经历了...

教你轻松制作自动换行的CSS布局,轻松应对不同设备!

在网页设计中,自动换行的CSS布局是非常常见的需求,特别是在响应式设计中。它可以让网页内容自动适应不同屏幕尺寸,保证用户在不同设备上都能够获得良好的浏览体验。本文将介绍几种制作自动换行的CSS布局的方...

晨光微语!一道 CSS 面试题,伴你静享知识治愈时光

当第一缕阳光温柔地爬上窗台,窗外的鸟鸣声清脆悦耳,空气中弥漫着清新的气息。在这宁静美好的清晨与上午时光,泡一杯热气腾腾的咖啡,找一个舒适的角落坐下。前端的小伙伴们,先把工作的疲惫和面试的焦虑放在一边,...

2023 年的响应式设计指南(什么是响应式设计优缺点)

大家好,我是Echa。如今,当大家考虑构建流畅的布局时,没有再写固定宽度和高度数值了。相反,小编今天构建的布局需要适用于几乎任何尺寸的设备。是不是不可思议,小编仍然看到网站遵循自适应设计模式,其中它有...