Atom+Asciidoctor+Antora环境搭建

2023-11-07

个人博客原文链接

Atom

简介

Atom是github专门为程序员推出的一个跨平台文本编辑器。具有简洁和直观的图形用户界面,并有很多有趣的特点:支持CSS,HTML,JavaScript等网页编程语言。它支持宏,自动完成分屏功能,集成了文件管理器。

安装【windows7】

1.下载
官网链接
2.安装
3.配置环境变量
path中添加C:\Users\Administrator\AppData\Local\atom\bin
4.检测环境变量是否配置成功
5.打开cmd,使用apm命令查看
6.介绍atom界面

  • File 文件和项目的保存与加载,设置中心,用户自定义配置
  • Edit 文件编辑的操作,文件编码格式,及行跳转等
  • View 重载页面,全屏,字体大小的缩放等
  • Find 都是关于查询的 ,跟Sublime text极其相似,快捷键基本一样
  • Package 包,就是插件列表的集合点
  • Help 帮助文档,软件更新,协议等

7.更改主题
打开Settings,在Themes页面选择即可
8.安装插件

  • 直接安装
    打开Settings,在Install页搜索插件名称,点击Install即可
  • 通过git手动安装
    打开Settings,在Install页搜索插件名称
    点入插件介绍找到github地址
    打开git切换到packages目录C:\Users\Administrator\AppData\Local\atom\packages
    输入指令git clone https://github.com/emmetio/emmet-atom.git
    切换到安装的插件文件夹cd emmet-atom
    开始安装npm install
    重启Atom

9.自定义快捷键
File -> 打开keymap.cson文件

Asciidoctor

简介

Asciidoctor是一个快速的文本处理器和发布工具链,用于将AsciiDoc内容转换为HTML5、EPUB3、PDF、DocBook 5(或4.5)slidedeck等格式。Asciidoctor是用Ruby编写的,打包为RubyGem并发布到(RubyGems.org)。gem还打包在几个Linux发行版中,包括Fedora、Debian和Ubuntu。

安装【windows7】

1.准备Ruby环境
下载安装并配置环境变量【若勾选自动添加到path则可略过】
下载链接
检测是否安装成功
在命令行输入:ruby -v
2.安装asciidoctor
在命令行输入:gem install asciidoctor
3.检测是否安装成功
在命令行输入:asciidoctor --version
4.如果需要绘制图表,还需要安装asciidoctor-diagram
在命令行输入:gem install asciidoctor-diagram
5.从asciidoc文档生成html文档(DEMO)
在命令行输入:asciidoctor -r asciidoctor-diagram xxx.adoc

Antora

简介

Antora可以很容易地创建文档并将其发布到web上。作为一名技术作者,您只需使用AsciiDoc (Antora的内容标记语言)编写内容。然后将这些文件组织到一个或多个内容存储库中的标准项目结构中。Antora从那里获取您的内容并将其转换为网站。

安装【winodws7】

1.准备Node环境
检测是否有node.js
打开命令行cmd,输入:node --version
如果没有返回版本信息则要去官网下载Node
官网链接
安装并配置环境变量,再检测是否安装成功
> 注:如果版本过低,可以去官网下载最新版本,然后安装覆盖原目录即可实现更新
2.开始安装antora
打开命令行cmd,输入:npm i -g @antora/cli@2.0 @antora/site-generator-default@2.0
命令解释:包名开头的@很重要。它告诉npm cli包位于antora组中。如果省略这个字符,npm将假定包名是GitHub上git存储库的名称。第二个@抵消了请求的版本号。只指定主要和次要部分,以确保您接收到最新的补丁更新。
3.检测是否安装成功
在命令行输入:antora version

简单的使用流程

1.选择一个剧本
要创建文档站点,Antora需要一个剧本。但首先,您需要创建或选择一个目录,在其中存储剧本,并保存生成的站点文件(假设使用默认输出配置)。
a.打开终端并创建一个名为demo-site的新目录。
mkdir demo-site
b.进入到该目录中
cd demo-site
c.使用文本编辑器或IDE,创建一个名为site的新剧本文件。用下面示例的内容填充它。
site.yml

site:
  title: Antora Demo Site
  url: https://example.org/docs 
  start_page: component-b::index.adoc 
content:
  sources:
  - url: https://gitlab.com/antora/demo/demo-component-a.git
	branches: master
  - url: https://gitlab.com/antora/demo/demo-component-b.git
	branches: [v2.0, v1.0]
	start_path: docs
ui:
  bundle:
	url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
	snapshot: true

注:404页面和站点地图文件仅在站点生成时生成。设置url属性。
注:该网站。site.start_page属性接受与xref中使用的相同的页ID语法。
d.将site.yml剧本作为站点保存

2.运行Antora
a.要使用默认的Antora站点生成器生成站点,请将Antora命令指向您的playbook文件。在终端输入命令
antora site.yml
> 注:首先,Antora将克隆内容存储库。终端显示每个存储库的克隆进度。克隆完成后,Antora将AsciiDoc页面转换为可嵌入的HTML,在UI页面模板中包装HTML,然后将这些页面组装到目标文件夹下的站点中,默认构建目录bulid/site/。
b.当命令提示符($)重新出现在终端时,Antora已经运行完成。
c.切换到站点文件夹(cd)并列出其内容。
cd build/site/
ls -l
然后你将看到以下文件或目录列表
_ 404.html component-a component-b index.html sitemap-component-a.xml sitemap-component-b.xml sitemap.xml
> 注:如果站点不存在,404.html和sitemap文件将丢失。剧本中没有定义site.url属性。主sitemap文件实际上是一个sitemap索引。该文件链接到每个组件的sitemap,在这里可以找到各个页面的URL。
d.在某些操作系统上,可以通过输入open和HTML文件的名称,直接从命令行打开站点。
open index.html
> 注:或者可以直接通过build/site/index.html打开站点

3.缓存
a.当Antora第一次运行时,它将在缓存目录中缓存资源。Antora缓存两种类型的资源:克隆的git存储库和UI包下载。
b.如果您想完全清除缓存,您需要找到系统上的Antora缓存目录并删除它。

4.私人git仓库
a.Antora支持通过SSH或HTTP/HTTPS来连接私有仓库。 b.如果剧本被配置为通过SSH获取私有存储库,那么您必须运行具有标识的SSH代理(即您已经链接到git主机上的帐户。如果SSH代理没有运行,或者您的密钥和帐户不匹配,Antora在尝试克隆私有存储库时将失败。

5.本地预览
a.因为Antora生成静态站点,所以不需要为了预览站点而将站点发布到服务器,可以直接通过build/site/index.html打开站点
b.也可以在本地服务器上运行,需要先使用npm全局安装服务包
npm i -g serve@6.5.8
现在,通过将web服务器指向生成的站点的位置来启动它
serve build/site
将提供的URL粘贴到浏览器的位置栏中,以便通过本地web服务器查看站点。
6.发布到github页面
注意事项:避免站点发布到github page被删除UI相关文件内容,解决方案是将.nojekyll文件添加到已发布站点的根目录中。在将文件提交到GitHub页面之前,只需在输出目录中创建一个空的.nojekyll文件。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Atom+Asciidoctor+Antora环境搭建 的相关文章

  • 基于SSM的亲子活动平台的搭建与实现(源码+数据脚本+论文+技术文档)

    项目描述 临近学期结束 xff0c 还是毕业设计 xff0c 你还在做java程序网络编程 xff0c 期末作业 xff0c 老师的作业要求觉得大了吗 不知道毕业设计该怎么办 网页功能的数量是否太多 没有合适的类型或系统 等等 这里根据疫情
  • 如何在 Ubuntu 18.04 上安装 Atom 文本编辑器

    Atom是由GitHub开发的开源跨平台代码编辑器 它有一个内置的包管理器 嵌入Git控制 智能自动完成 语法突出显示和多个窗格 从本质上讲 Atom 是一个基于 Electron 构建的桌面应用程序 使用 HTML JavaScript
  • ESB产品Oracle数据库升级说明

    ESB企业服务总线平台作为支撑企业综合集成的产品 在应用集成 数据集成 数据治理等解决方案都发挥着非常重要的作用 随着产品和解决方案的不断优化和升级 ESB企业服务总线平台功能需要逐步进行完善 不断提升产品功能的完备性 易用性和全面性 为了
  • 安全体系建立标准

    随着我国企业信息化的普及 信息化给我国企业带来积极影响的同时 也带来了信息安全方面的消极影响 一方面信息化在企业发展的过程中 对节约企业成本和达到有效管理起到了积极的推动作用 另一方面伴随着全球信息化和网络化进程的发展 与此相关的信息安全问
  • C#中实现简单文件读写(附源代码)

    主要代码 using System IO Read File private void button1 Click object sender System EventArgs e try openFileDialog1 Filter tx
  • 【ubuntu软件】atom笔记软件----下载、配置、使用

    最近平台切换到了ubuntu环境 很多软件都不能用了 今天看下atom这个笔记软件的下载 配置及其使用 一 为什么选择atom atom是免费的 这个及其重要 其次atom是跨平台的 二 下载 1 官网下载 下载地址 https atom
  • 做一个统计单词数目的Atom插件

    本文是Atom 教程 制作单词计数插件的简化介绍 所有代码都来自这篇文章 如果希望参考详细的文档 请直接查看原文 这篇文章用一个简单的小例子 为我们讲解了如何编写一个Atom编辑器插件 该例子使用的是CoffeeScript 所以为了更好地
  • Atom+Asciidoctor+Antora环境搭建

    个人博客原文链接 Atom 简介 Atom是github专门为程序员推出的一个跨平台文本编辑器 具有简洁和直观的图形用户界面 并有很多有趣的特点 支持CSS HTML JavaScript等网页编程语言 它支持宏 自动完成分屏功能 集成了文
  • 强力推荐:Atom入坑必备插件

    You are my warm gloves my cloud beer my sun kissed shirt my day after day dreams 你是我温暖的手套 冰冷的啤酒 带着阳光味道的衬衫 日复一日的梦想 强力推荐 A
  • 如何在 Fedora 36/35/34 上安装 Atom 文本编辑器

    Atom是一个现代的开源文本或源代码编辑器 它的核心是可破解的 这意味着这个工具可以定制来执行任何操作 它适用于 OS X Linux 和 Windows 系统 本文将帮助您在 Fedora Linux 系统上安装 Atom 文本编辑器 您
  • 系统监控脚本说明

    系统管理员的任务比较艰难 因为需要监控服务器 用户 日志 还得创建备份等 对于大多数重复性的任务 一般管理员都会写一个自动化脚本来完成这些任务 在以往运维中 查询系统 数据库等参数都比较困难 需要手动输入对应的命令 极其不方便 脚本也是我们
  • Idea自带的http client工具使用攻略

    平时都是用postman来调接口 有时候也会用到swagger 用swagger还可以 直接在浏览器上开个页面即可 但是postman就不行了 需要单独的运行 个人感觉postman还是比较占内存的 最近和一个其他组同事联调 发现他们使用的
  • iOS开发之内存管理

    iOS开发之内存管理 一 垃圾回收机制 二 内存管理的概念 三 OC内存管理注意事项 四 MRC相关语法 一 垃圾回收机制 与Java语言相同Objective c 2 0之后 也提供了垃圾回收机制 OC是支持垃圾回收机制的 Garbage
  • 如何在 CentOS 7 上安装 Atom 文本编辑器

    Atom是由GitHub开发的开源跨平台代码编辑器 它有一个内置的包管理器 嵌入Git控制 智能自动完成 语法突出显示和多个窗格 从本质上讲 Atom 是一个基于 Electron 构建的桌面应用程序 使用 HTML JavaScript
  • Antora顶部导航栏定制

    我的问题很简单 尽管我在文档中找不到任何指向它的内容 我正在使用 Antora 中的默认生成器为项目生成文档 但我不知道如何自定义顶部导航栏 右侧的项目 这些项目有一些默认值 既然网站已生成 我应该在哪里更改或如何更改这些项目 我不想在那里
  • AsciiDoc 在列表块内添加粗体文本

    有一些 AsciiDoc 有一个类似的块 this is a test with some formatted tabbed text in it blah 我希望文本显示为 this is a test with some formatt
  • 如何在 Python 中使用 AsciiDoc?

    最初的 AsciiDoc 处理器是用 python 编写的 但 AsciiDoc 演变为用 Ruby 编写的 Asciidoctor 形式 在我搜索如何处理现代 AsciiDoc Asciidoctor 方言 时 我只看到一篇文章 说有一个
  • 如何使用 tocify 和 asciidoctor 来生成动态目录?

    默认情况下 阿斯西多克 http asciidoctor org创建静态目录 这非常酷 但对于长文档 如果目录可以更紧凑并突出显示读者当前在文档中的位置 那就太好了 在此刻 tocify http gregfranko com jquery
  • 使用 asciidoctor 创建自定义 HTML

    我正在使用 CMS 来发布我的博客文章 我正在寻找一种从简单的文本文件离线创建 HTML 文章的方法 这是我通常在文章中使用的一段 HTML p We want to show how you can gather information
  • asciidoctor 是否有设置从其输出的源中删除

    标签?

    我正在使用 asciidoctor 在 Drupal 中开发自定义过滤器 并意识到 asciidoctor 将输出放在 div class paragraph p tags 它是否有一个设置可以从输出中删除这些标签并仅返回内部 HTML 有

随机推荐