YARD
pages-gem
YARD | pages-gem | |
---|---|---|
18 | 586 | |
1,905 | 1,809 | |
- | 0.3% | |
6.5 | 8.1 | |
about 1 month ago | about 1 month 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).
pages-gem
-
How to build your interactive resume in 4 simple and 2 easy steps
It's super easy to publish a static site like the resume with GitHub Pages. Just check out the docs.
-
100+ FREE Resources Every Web Developer Must Try
GitHub Pages: Host your static websites directly from your GitHub repository.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Top 20 Free Static Web Hosting Services in 2024 ⚡️
Ideal for open source projects, docs sites, and portfolios. GitHub Pages
-
Creating an Engaging Curriculum vitae using Github Pages: A Step-by-Step Guide
Github Pages: Link to Github Pages
-
Different Levels of Project Documentation
Once you have all the documentation worked out a place to host it will be necessary. Some documentation generation may have ties in with specific hosting sites. Read The Docs' support for Sphinx and other documentation tools is one example. GitHub pages can be useful for GitHub hosted projects as it integrates well with GitHub Actions CI/CD deployments.
-
The minimalist guide to deploying a website in 2023 🧘
If you use GitHub and need to host a static website, consider GitHub Pages. Free for one site Stored on a GitHub public respository Deploy via web interface, or Git 100GB/month free bandwidth
-
I made a simple website 100% for FREE! 🤯
https://pages.github.com/ https://docs.github.com/en/pages https://docs.github.com/en/pages/quickstart https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll
-
How to host my own website from GitHub
There are plenty of other hosting options you could use instead, such as GitHub Pages.
-
A page to see all revealed Affliction Gems at once
Functionally github.io just presents whatever you throw into the repository as the root directory of a site, github themselves host a very good, basic outline of how to set up a site on github.io.
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
al-folio - A beautiful, simple, clean, and responsive Jekyll theme for academics
Apipie - Ruby on Rails API documentation tool
neocities - Neocities.org - the web site. The entire thing. Yep, we're completely open source.
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
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
Docusaurus - Easy to maintain open source documentation websites.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
git - A fork of Git containing Windows-specific patches.