git-subrepo
Asciidoctor
git-subrepo | Asciidoctor | |
---|---|---|
19 | 35 | |
3,129 | 4,647 | |
- | 0.7% | |
2.1 | 8.7 | |
about 1 month ago | about 1 month ago | |
Shell | 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.
git-subrepo
- Git-Subrepo: Git Submodule and Subtree Alternative
-
Monorepo advice
git-subrepo - complicated and difficult to understand
-
is there any way to combine old repositories into onto one repo?
I find the following approach more consistent to manage components: https://github.com/ingydotnet/git-subrepo . And native package management systems, like npm in JavaScript universe, superior to either of the above. But the choice of a particular method depends on problems we need to solve. In terms of one-time codebase aggregation method they are all equally fine.
-
Git Commands You Probably Do Not Need
I much prefer https://github.com/ingydotnet/git-subrepo
- Git-Subrepo – Git Submodule Alternative
-
Just Use a Monorepo
Where I work we just package everything (nugets, python packages, npm) on our Artifactory. Contracts dependencies (DLLs, protobufs) are also distributed as packages. We made it easy to fetch and test the source and allow developers to develop, debug and test those dependencies with their own project if needed.
Every time we try to assemble repositories in macro-repos we always end up regretting it. Multiple dedicated repositories allow autonomy for teams and enforce modularity and coding as a library. Monorepos have a tendency of becoming huge merge trains easily and often derailed and with lots of fear of being blamed on stepping on someone else's toes.
We update often all our projects knowing full well that not doing so is just borrowing development time at high interest rate.
As a side-note when we do have to do an assembly of different code base, we use git-subrepo: https://github.com/ingydotnet/git-subrepo which provide the best of both submodules and subtree.
-
How to get yaml from upstream repo into monorepo
v2: I use git subrepo or a similar tool, to get the upstream yaml into my repo.
-
Do you use git-subrepo?
I found git-subrepo: https://github.com/ingydotnet/git-subrepo
-
Using Git Subtree vs SubModule?
You might also check out git subrepo.
-
Show HN: Get rid of Git submodules and never look back (now for GitHub users)
Besides these git x-modules, there are historically three contenders:
git submodules: https://git-scm.com/book/en/v2/Git-Tools-Submodules
git subtrees: https://www.atlassian.com/git/tutorials/git-subtree
git subrepos: https://github.com/ingydotnet/git-subrepo
---
git subrepos work simply by copying your dependency to a subdirectory and committing the changes using one large commit that retains metadata about the update to the subrepo. For that reason, git subrepos aren't symlinks. You don't need to git clone --recursive like with git submodules, and you don't need cross-repo authentication. Updating a subrepo means performing another commit.
Even though git subrepos are the most poorly maintained, the design is simpler.
I wish someone would fork and take over maintenance.
git subrepos are the best.
Asciidoctor
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
AsciidocFX, is an open-source, cross-platform editor that provides an exceptional user experience and a comprehensive set of features for working with Asciidoc files. Though Asciidoctor provides these capabilities, not everyone will be comfortable enough to work in the commandline or shell setting that's where AsciidocFX comes to the rescue. Let's explore some of the key capabilities that make AsciidocFX stand out.
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ).
-
[DEV][App Release] Markor 2.11 adds AsciiDoc and CSV Support
AsciiDoc File support. ( #1876, #808, #2022)
-
Good software/SaaS for Technical Documentation CMS
If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/
-
Documentation generators and custom syntax highlighting
I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:
-
I wish Asciidoc was more popular
AsciiDoc is so close to being good. It slam dunks Markdown, but they just have a few nagging issues that they refuse to fix, for 9 years now:
https://github.com/asciidoctor/asciidoctor/issues/1087
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax highlighting), as well as Font Awesome (for icons). Although Asciidoctor is written in Ruby, that does not mean you need to know Ruby to use it. Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js. You can choose any one of three Asciidoctor processors (Ruby, JavaScript, Java/JVM) and get the same experience. You can also use the Asciidoctor Maven Plugin to convert your Asciidoc documentation using Asciidoctor from an Apache Maven build.
-
Designing Go Libraries: The Talk: The Article
asciidoctor for writing
-
Docs as code vs a tool that can work with .md and xml?
If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/
- Diving deeper into custom PDF and ePub generation
What are some alternatives?
hubris - A lightweight, memory-protected, message-passing kernel for deeply embedded systems.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
gradesta - Stitchable spreadsheets for the 21st century
Zettlr - Your One-Stop Publication Workbench
ferros - A Rust-based userland which also adds compile-time assurances to seL4 development.
plantuml - Generate diagrams from textual description
tock - A secure embedded operating system for microcontrollers
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
omicron - Omicron: Oxide control plane
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
zsh-bootstrap - bootstrap my zsh shell
hugo-PaperMod - A fast, clean, responsive Hugo theme.