YARD
Middleman
Our great sponsors
YARD | Middleman | |
---|---|---|
18 | 15 | |
1,905 | 7,015 | |
- | 0.2% | |
6.9 | 7.8 | |
22 days ago | 11 days ago | |
Ruby | Ruby | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
YARD
-
What is JSDoc and why you may not need typescript for your next project?
JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..
-
Xeme: I'd value your opinion on my new Ruby gem
In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
-
Programming types and mindsets
I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
-
kwargs and YARD: @param or @option?
I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:
-
Comparing RDoc, YARD, and SDoc: Choosing the Right Documentation Generator for Your Ruby on Rails 5 Project
YARD: http://yardoc.org/
-
How do you document your code?
I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
-
The right is on the left
That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
-
#buildinpublic, issue 1: building API documentation browser for command line
My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
-
The Why and How of Yardoc
I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
-
Graphic representation of class / module inheritance in Rails?
That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
Middleman
-
“Make” as a Static Site Generator
Most of the Static Site Generators default to generating blog from markdown, which is not feasible for company websites etc. For such projects I like Middleman (https://middlemanapp.com) which provides layouts/partials and things like haml templates.
-
Bloggers who host statically, do you use Jekyll or Pelican to roll your blog posts?
I've done similar with Middleman, and I'm 99% sure you could set this up with Pelican if you wanted. It sounds like the site generation workflow is the issue rather than the tool.
- [student help] Using Rails as front end. Is it possible?
-
Show HN: Self-hosted CMS on Cloudflare for podcast/blog/images/videos/docs/URLs
I use middleman[^1] + bulmaCSS + FontAwesome but host on github using the `github.io` domain and upload podcasts to "archive.org"[^2]. The reason I choose this setup is because I want the content to survive as much as possible, hence open source technology and "free & long lived" hosting were requirements.
[^1]: https://middlemanapp.com/
[^2]: https://archive.org/
-
Web app architecture design process guidance
Thanks u/Draegan88, but what's Middleman got to do with app architecture & design/ERD/schema design?
-
Building Static Websites w/ Rails in 2022
I came across Middleman but it's meant to work with Ruby not necessarily Rails, it's also a bit old although appears kept up to date.
- Eu sou Desenvolvedor de Software Sr. AMA!
-
CMS > MiddlemanApp > static Site - how to start middleman on heroku?
A simple middleman app consumes the data and builds a static export that runs standalone (just HTML, CSS and some JS files). That gets FTP'd/released to the webserver.
-
SSGs through the ages: The ‘After Jekyll’ era
Middleman
-
What is your development setup (IDE, gems, library, ci/cd etc) for RoR/non-RoR applications development ?
For my personal site, which is 10 years old, I use Middleman, and I deploy the site to S3/Cloudfront with s3_website. It works fine for now. If s3_website stops working, I'll move to Netlify probably.
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
Apipie - Ruby on Rails API documentation tool
Bridgetown - A next-generation progressive site generator & fullstack framework, powered by Ruby
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Nanoc - A powerful web publishing system
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
Hugo - The world’s fastest framework for building websites.
Annotate - Annotate Rails classes with schema and routes info
Awesome Jekyll - A collection of awesome Jekyll goodies (tools, templates, plugins, guides, etc.)
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Octopress - Octopress 3.0 – Jekyll's Ferrari