分享自己写的文档工具(Ruby - Sinatra)

在线地址

 

http://dayang.cloudfoundry.com/about

 

使用markdown语法进行文档编写, 使用Git进行文档共享.  

 

 

使用到的技术:

Ruby, Sinatrarb, Markdown; 在看这篇文章的时候,只要你知道如何启动 Sinatra.

 

如何编写文档:

1. 使用常用的开发工具,编写*.md文件,然后将其放到views/文件夹下.

2. 启动sinatrarb server. 使用浏览器访问即可.

程序会将md文件的第一行内容作为的标题, 将md文件的文件名作为文档url.  

 


 

如果你对代码感兴趣,可以看这里:

https://github.com/lvjian700/dydoc

 

代码使用方法:

git clone git://github.com/lvjian700/dydoc.git

cd dydoc

bundle install

ruby app.rb

 

这里还有一个 node.js 版本,可能你会感兴趣:

 

使用node.js建markdown博客文章总汇:

http://witcheryne.iteye.com/blog/1172069

 

 

 

sinatra-croon:为用 Sinatra 编写的 API 生成文档 辛纳屈::克朗 允许您将内嵌文档添加到 Sinatra 应用程序,并提供基于 Web 的文档浏览器。 用法 require "sinatra/croon" class MyApp < Sinatra> the name of the application to create # @param [stack] the stack on which to create the application # # @request # POST /apps.json # name=example&stack=bamboo-ree-1.8.7 # @response # { # "id": 1, 立即下载

相关推荐

sinatra-graphql:分步教程在sinatra(ruby)中编写graphql服务器

带有Sinatra的GraphQL服务器(Ruby) 使用 gem在sinatra(ruby)中编写graphql服务器的分步教程。 脚步 步骤1:创建Sinatra应用程序 步骤2:添加JSON响应 步骤3:使用ActiveRecord添加数据库连接和模型 步骤4:添加graphql并定义查询以列出发言者 步骤5:添加突变根类型 步骤6:为说话者创建定义变体 在Medium阅读更多 第1部分 第2部分-

初识sinatra

Sinatra 是一门基于 Ruby 的领域专属语言,致力于轻松、快速地创建网络应用。 安装命令:gem install sinatra 创建一个测试文件:hello.rb 内容如下: require 'sinatra' get '/' do 'Hello world!' end 执行程序:ruby hello.rb 打开浏览器,按端口号输入本地uri,就可以看到自己的内容了...

wufeng_no1的博客 472

CASIA数据集解析:图像篡改检测的黄金标准与实践指南

本文深入解析了CASIA数据集在图像篡改检测领域的核心价值与应用实践。作为中科院自动化所打造的黄金标准,CASIA数据集通过模拟真实篡改场景(如拼接和复制移动)为研究者提供全面支持。文章详细对比了v1.0与v2.0版本差异,分享数据预处理和模型训练的最佳实践,并探讨了未来研究方向,是图像篡改检测领域的重要参考指南。

kappa的博客 784

sinatra 基本用法

sinatra 不同于rails,是一个轻量级的ruby 框架,非常轻巧灵活。基本用法如官网所述:#!/usr/bin/env ruby require 'sinatra' get '/frank-says' do   'Put this in your pipe &amp; smoke it!' end默认会监听在127.0.0.1:4567 ,可以稍加配置,如下:#!/usr/bin/env...

weixin_33717117的博客 1088

用STM32的SPI模式2搞定SSI绝对值编码器通信(附完整代码与避坑点)

本文详细解析了如何使用STM32的SPI模式2实现SSI绝对值编码器通信,包括硬件设计、SPI配置、数据处理算法及稳定性优化技巧。通过完整的代码示例和避坑指南,帮助工程师解决时序匹配、数据解析等常见问题,提升工业自动化系统中的编码器通信可靠性。

weixin_27252001的博客 264

endnote让参考文献整整齐齐

这篇文章主要是针对利用 endnote 插入参考文献时,参考文献第一行和后面的行对不齐的问题 下面是示意图 可以看到我们的参考文献对的整整齐齐的,比较好看。 下面介绍具体步骤 1、打开endnote。编辑我们使用的参考文献样式。我这儿是叫 ZZ_MODIFIED_GEEBINF 复制 2、找到布局,每个参考开头,将光标放在在参考开头后面,点插入字段,制表符 3、右下角悬挂式输出哪儿选择全部段...

雾隐雾现的至渝博客 5万+

cinatra中文开发文档

2020年8月5日09:40:20 cinatra--一个高效易用的c++ http框架 English | 中文 目录 cinatra简介 如何使用 快速示例 性能测试 注意事项 roadmap 联系方式 cinatra简介 cinatra是一个高性能易用的http框架,它是用modern c++(c++17)开发的,它的目标是提供一个快速开发的c++ http框架。它的主要特点如...

Z.X的博客 1101

STM32F4与LAN8720硬件连接避坑指南:从原理图到RMII信号完整性的实战解析

本文深入解析了STM32F4与LAN8720以太网连接的硬件设计要点与常见陷阱。重点剖析了电源上电时序、复位电路设计、RMII接口配置等关键环节,并提供了从原理图设计到PCB布局、信号完整性调试的完整实战指南,帮助硬件工程师规避设计风险,确保以太网通信的长期稳定运行。

weixin_29189003的博客 211

Rails 和 Sinatra 的区别是什么?

在 IBM Bluemix 中国版的应用程序中看到Ruby Sinatra,于是想知道它和 Rails 有什么区别,但搜索一番,发现国内几乎没人关注这个问题,可能国内使用Ruby的就比较少。 有一个比较好的问题:用 Sinatra 构建网站,你会怀念 Rails 的什么特性? 但很可惜,回复并不让人满意,值得的参考的: sinatra 写应用, 一般都...

weixin_33737134的博客 317

算法导论之线性规划

线性规划,充斥着运筹学,在图的单源最短路径求解差分约束系统就是用到线性规划。怎么样问题可以建模为线性规划来解决呢?在给定的有限的资源和竞争约束情况下,取得最大化或最小化目标的问题。导论中给出政治竞选问题、航空航线调度问题、钻井采油问题。最大化或最小化目标是函数的因变量,自变量就是资源的约束因素,其函数就是由这些制约因素构成的等式或不等式。下面数学定义下线性规划。 在一般线性规划问题中,最优化一个

医疗影像检索 2万+

树上柑橘检测实战:自制数据集与YOLO训练全流程复盘

目标检测模型的性能上限往往由训练数据决定,尤其在农业视觉这样的复杂场景中,公开数据集与真实环境的差异常导致模型漏检、误检频发。高质量的标注数据是模型泛化的基础,从采集、清洗到统一标注规范,每一步都直接影响最终效果。对于检测任务而言,VOC与YOLO两种主流标注格式的转换是工程落地的常见环节,理解坐标归一化原理并做好校验,能有效避免训练事故。在模型训练阶段,合理划分数据集、谨慎选择数据增强策略,并结合切片推理解决小目标漏检,是果园场景下提升精度的关键。这套基于2511张果树图像的单类别检测流程,不仅支撑了柑橘

weixin_29057163的博客 230

sinatra制作简易登录页面

sinatra 是基于ruby语言实现的http路由kuangj

vah101的专栏 3517

【虚幻引擎UE】UE5 四步骤实现AI漫游与对话行为(含工程源码)

【虚幻引擎UE】UE5 四步骤实现AI漫游与对话行为(含工程源码)

灵境引路人 3227

Google Glass Mirror API Ruby/Sinatra 模板应用教程

Google Glass Mirror API Ruby/Sinatra 模板应用教程 1. 项目介绍 Google-Glass-Starter-Sinatra-App 是一个用于创建 Google Glass Mirror API 应用程序的 Ruby on Sinatra 模板。该项目提供了一个基础框架,使开发者能够快速启动并运行一个能够连接到 Google Glass 并与第三方服务集成的应...

gitblog_01059的博客 1052

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

Google Glass Mirror API Ruby / Sinatra 模板应用推荐

Google Glass Mirror API Ruby / Sinatra 模板应用推荐 项目介绍 Google Glass Mirror API Ruby / Sinatra 模板应用是一个为开发者提供的快速搭建 Google Glass 应用的脚手架。该项目基于 Ruby 和 Sinatra 框架,旨在简化开发者连接 Google Glass 和其他服务的过程,并实现从 Glass 到其他服...

gitblog_00794的博客 897

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

Monocle架构深度解析:Ruby + Sinatra构建高性能聚合服务

Monocle是一个基于Ruby和Sinatra框架构建的高性能链接与新闻分享聚合服务,它采用现代化的架构设计,能够高效处理内容聚合、用户交互和数据管理等核心功能。本文将深入剖析Monocle的架构设计、技术选型和核心实现,帮助开发者理解如何使用Ruby生态系统构建轻量级但功能强大的Web应用。 ## 一、整体架构概览:轻量级微框架的高效实践 Monocle采用了经典的MVC(模型-视图-控制

gitblog_00139的博客 748

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

Ruby语言的软件开发工具

本文详细介绍了Ruby语言中的多种软件开发工具,包括环境管理工具、包管理工具、Web框架、测试工具和代码质量工具。通过使用这些工具,开发者可以显著提高开发效率,保证代码质量,快速构建出高性能的应用。在实际开发中,选择适合自己项目的工具组合是十分重要的。希望通过本文的介绍,能够帮助开发者更好地理解和使用Ruby语言的开发工具。无论是初学者还是资深开发者,都能在Ruby的世界中找到适合自己的工具,提升开发体验和效率。

2401_90031868的博客 961

构建LinkedIn社交应用:基于linkedin gem的Sinatra项目实战教程

想要快速构建专业的LinkedIn社交应用吗?这个终极指南将教你如何使用Ruby的linkedin gem和Sinatra框架,在短短30分钟内创建一个功能完整的LinkedIn集成应用。无论你是Ruby初学者还是经验丰富的开发者,这个简单快速的教程都将帮助你掌握LinkedIn API的核心功能。 LinkedIn是全球最大的职业社交平台,拥有超过9亿用户。通过LinkedIn API,你可以

gitblog_00937的博客 927

Captura:录屏、混音、按键全捕获

Captura 是一款 Windows 平台的开源屏幕录制工具,能把画面、系统音频、麦克风、鼠标点击和按键操作同步录进同一个文件。做教程、远程演示或写文档时,不用再在录屏、混音、字幕工具之间来回切换。 ## 录教程时总漏掉的那几样东西 你可能也遇到过:录完一段操作演示,回放时才发现系统提示音没进去;观众看不清鼠标点在了哪个按钮上;想把快捷键步骤标出来,又得另开剪辑软件手打字幕。Captura

gitblog_00660的博客 361

Sinatra高级技巧:过滤器、错误处理与性能优化实战

Sinatra作为一款轻量级的Ruby Web框架,以其简洁的DSL语法和灵活的扩展性深受开发者喜爱。本文将分享三个提升Sinatra应用质量的核心技巧:过滤器的高级应用、优雅的错误处理机制以及实用的性能优化策略,帮助你构建更健壮、高效的Web应用。 ## 一、掌握过滤器:请求流程的隐形指挥官 过滤器是Sinatra中控制请求处理流程的强大工具,能够在请求到达路由处理之前或之后执行特定逻辑。最

gitblog_00933的博客 1035

几种实用型Ruby Web开发框架介绍

大家在通过对Ruby的学习后,都知道,Ruby on Rails是一款性能非常优越的Ruby Web开发框架。但是其他的Ruby Web开发框架又有多少人知道一二呢? 迅速掌握Ruby文件锁概念Ruby操作文件权限技巧分享Ruby will_paginate知识堂详细解读Ruby输出文件信息实现方式Ruby元编程构造简单优雅解决方案 Rails尽人皆知,有人甚至可能听说过Merb和

dazhi_100的专栏 3882
上一篇: 用二十来页PPT做个年终总结及规划
下一篇: 用ruby+java, 同步C++和数据库中的注释.
lvjian700
博客等级 码龄15年 14粉丝 13原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值