asciidoctor-foodogsquared-extensions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9f519d0ae3e0ac0e73c26e85acb925d53b9b937019d0361ee82b47fa4f8466a
+  data.tar.gz: b25430e1aeb1dee8b2563dc859a45879ed283698e4cdadef73f534a9a9876aaa
+SHA512:
+  metadata.gz: 307b4db3e7bc66f0ea323344fb177d90c65c3141aa714891277b76cfb656fc501f7ca7e9788e7dbeee7141637e2ec0cea2d0f13b409679f854840ae1b76c0163
+  data.tar.gz: 63dfa05bd984ea781cb53791a155303e162c1b6b6f582140b28f1804bc20c86fdeee7aaae523c5ec410266417130dba8852801b50d2cc5cc1e727e656a530b9a

data/asciidoctor-foodogsquared-extensions.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'asciidoctor-foodogsquared-extensions'
+  s.version       = '1.0.0'
+  s.licenses      = ['MIT']
+  s.summary       = "foo-dogsquared's custom Asciidoctor extensions"
+  s.description   = <<-DESC
+    foo-dogsquared's custom Asciidoctor extensions as a Gem. This is not meant
+    to be used in production or as a public Gem. This is used since Hugo
+    doesn't allow loading Asciidoctor extensions with path separators.
+  DESC
+
+  s.required_ruby_version = '>= 3.0.0'
+
+  s.authors       = ['Gabriel Arazas']
+  s.email         = 'foodogsquared@foodogsquared.one'
+  s.metadata      = { 'source_code_uri' => 'https://github.com/foo-dogsquared/foo-dogsquared.github.io' }
+
+  s.files         = Dir['lib/**/*', '*.gemspec']
+
+  s.add_runtime_dependency 'asciidoctor', '~> 2.0'
+  s.add_runtime_dependency 'rugged', '~> 1.0'
+end

data/lib/asciidoctor/chat-block-processor/README.adoc

@@ -0,0 +1,115 @@
+= Chat block processor
+:toc:
+
+
+A link:https://docs.asciidoctor.org/asciidoctor/latest/extensions/block-processor/[block processor] that adds a a dialog box style to the block.
+Exclusive to the HTML backend.
+
+
+== Synopsis
+
+....
+[chat, $AVATARNAME, $AVATARSTATE, $ATTRS...]
+====
+$CONTENT
+====
+....
+
+The avatar name is the name of the folder to be retrieved from the `avatarsdir` attribute.
+The directory enforces a certain structure which can be seen in <<extra-notes>>.
+
+Both the avatar name and the state are to be converted to snake case (e.g., `El Pablo` to `el_pablo`) for the image path.
+
+
+== Attributes
+
+* `avatarsdir` is the folder containing the avatars' stickers.
+This is explained in detail from the <<extra-notes>> section.
+
+* `avatarstype` is similar to `icontype` attribute except this is used for the avatar stickers.
+The default value is `webp`.
+
+* `state` is the sticker to be retrieved from the avatars directory.
+It has a default value of `default`.
+You could also use this attribute instead of the `$AVATARSTATE` positional argument for whatever reason.
+
+* `name` is the canonical name of the avatar.
+This is used for titles and alts in the internal image block.
+By default, this is the same as the given avatar.
+
+
+[#extra-notes]
+== Extra notes
+
+This component has some prerequisites for this to fully work specifically with `avatarsdir` attribute that contains a list of avatars and their stickers.
+By default, this value is at the `avatars` subdirectory of the `iconsdir` attribute.
+It is recommended to set this value yourself.
++
+--
+This enforces a certain structure where the root directory contains a list of folders representing the avatar with each of the folder containing stickers which represents their state.
+For example, here's what `avatarsdir` could contain following the expected structure.
+
+[source]
+----
+./static/icons/avatars/
+├── ezran/
+│   ├── crisis.webp
+│   ├── default.webp
+│   ├── sad.webp
+│   └── shocked.webp
+└── foodogsquared/
+    ├── crisis.webp
+    ├── default.webp
+    ├── sad.webp
+    └── shocked.webp
+----
+--
+
+
+== Example usage
+
+Let's assume `avatarsdir` is set to the `static/icons/avatars` with the following file structure.
+
+[source]
+----
+./static/icons/avatars/
+├── ezran/
+│   ├── crisis.webp
+│   ├── default.webp
+│   ├── sad.webp
+│   └── shocked.webp
+├── el-pablo/
+│   ├── crisis.webp
+│   ├── default.webp
+│   ├── ghastly.webp
+│   ├── melodramatic.webp
+│   ├── sad.webp
+│   └── shocked.webp
+└── foodogsquared/
+    ├── crisis.webp
+    ├── default.webp
+    ├── sad.webp
+    └── shocked.webp
+----
+
+- The following block should get the default image for `foodogsquared` which is in `./static/icons/avatars/foodogsquared/default.webp`.
++
+....
+[chat, foodogsquared]
+====
+Hello there!
+====
+....
+
+- The following block should contain El Pablo's melodramatic dialog state.
+Take note of the resulting path for the image which is in kebab-case.
++
+....
+[chat, El Pablo, state=melodramatic]
+====
+What tragedy is happening here!
+I couldn't take it.
+
+__Please__.
+====
+....

data/lib/asciidoctor/chat-block-processor/extension.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class ChatBlock < Asciidoctor::Extensions::BlockProcessor
+  use_dsl
+
+  named :chat
+  on_context :example
+  name_positional_attributes 'avatar', 'state'
+  default_attributes 'state' => 'default', 'avatarstype' => 'avif'
+
+  def process(parent, reader, attrs)
+    block = create_block parent, :pass, nil, attrs, content_model: :compound
+    block.add_role('dialogblock')
+
+    # You can think of this section as a pipeline constructing the HTML
+    # component for this block. Specifically, we're building one component that
+    # contains two output: the dialog image of our avatar and its content.
+    attrs['name'] ||= attrs['avatar']
+
+    block << (create_html_fragment block, %(
+      <div role="figure" class="dialogblock dialogblock__box dialogblock__avatar--#{attrs['avatar']} #{attrs['role']}">
+        <div class="dialogblock dialogblock__avatar">
+    ))
+
+    attrs['avatarsdir'] ||= File.expand_path('./avatars', attrs['iconsdir'])
+
+    avatar_sticker = "#{attrs['avatar'].to_kebab}/#{attrs['state'].to_kebab}.#{attrs['avatarstype']}"
+    avatar_img_attrs = {
+      'target' => parent.image_uri(avatar_sticker, 'avatarsdir'),
+      'alt' => attrs['name']
+    }
+    avatar_imgblock = create_image_block block, avatar_img_attrs
+
+    block << avatar_imgblock
+    block << (create_html_fragment block, %(
+        </div>
+        <div class="dialogblock dialogblock__text">
+          <small class="dialogblock dialogblock__avatar-name">#{attrs['name']}</small>
+    ))
+
+    parse_content block, reader
+
+    block << (create_html_fragment block, %(
+        </div>
+      </div>
+    ))
+
+    block
+  end
+
+  private
+
+  def create_html_fragment(parent, html, attributes = nil)
+    create_block parent, :pass, html, attributes
+  end
+end

data/lib/asciidoctor/fdroid-link-inline-macro/README.adoc

@@ -0,0 +1,36 @@
+= F-droid link inline macro
+:toc:
+
+
+An inline macro as a shorthand for F-droid links.
+
+
+== Synopsis
+
+[source, asciidoc]
+----
+fdroid:$APP_ID[$CAPTION]
+----
+
+Where...
+
+- `$APP_ID` is the application ID of the program (e.g., `org.moire.ultrasonic`).
+
+- `$CAPTION` is the link text.
+By default, it will use the display name of the application from its link:https://gitlab.com/fdroid/fdroiddata/[metadata repository].
+In other words, it will create an additional network request.
+
+
+== Attributes
+
+- `lang` is the language page to be linked.
+By default, it links to the English page of `en`.
+
+
+== Example usage
+
+- `fdroid:org.moire.ultrasonic[]` should link to the link:https://f-droid.org/en/packages/org.moire.ultrasonic/[F-Droid page for Ultrasonic] with the link text 'Ultrasonic'.
+
+- `fdroid:org.moire.ultrasonic[Hello there]` is the same as previous item but with the link text replaced with 'Hello there'.
+
+- `fdroid:org.moire.ultrasonic[lang=it]` is the same as the first list item but links to the link:https://f-droid.org/it/packages/org.moire.ultrasonic/[Italian page].

data/lib/asciidoctor/fdroid-link-inline-macro/extension.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'yaml'
+
+class FDroidLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+  use_dsl
+
+  named :fdroid
+  name_positional_attributes 'caption'
+  default_attributes 'lang' => 'en'
+
+  def process(parent, target, attrs)
+    doc = parent.document
+
+    app_id = target
+    app_metadata_uri = %(https://gitlab.com/fdroid/fdroiddata/-/raw/master/metadata/#{app_id}.yml)
+
+    if attrs['caption'].nil?
+      metadata = OpenURI.open_uri(app_metadata_uri) { |f| YAML.safe_load(f.read) }
+      attrs['caption'] = metadata['AutoName']
+    end
+
+    url = %(https://f-droid.org/#{attrs['lang']}/packages/#{app_id})
+    doc.register :links, url
+    create_anchor parent, attrs['caption'], type: :link, target: url
+  end
+end

data/lib/asciidoctor/flathub-link-inline-macro/README.adoc

@@ -0,0 +1,28 @@
+= Flathub link inline macro
+:toc:
+
+
+A shorthand for linking applications from link:https://flathub.org[FlatHub].
+
+
+== Synopsis
+
+[source, asciidoc]
+----
+flathub:$APP_ID[$CAPTION]
+----
+
+Where...
+
+- `$APP_ID` is the application ID of the program on Flathub.
+
+- `$CAPTION` is the link text to be used.
+By default, it will get the appstream metadata from FlatHub and use the display name.
+Take note it creates an additional network request to get the name.
+
+
+== Example usage
+
+- `flathub:org.gnome.design.IconLibrary[]` links to the link:https://flathub.org/apps/org.gnome.design.IconLibrary[FlatHub page of GNOME Icon Library] with `Icon Library` as the link text.
+
+- `flathub:org.gnome.design.IconLibrary[GNOME Icon Library]` is the same as the previous list item but with its link text replaced with `GNOME Icon Library`.

data/lib/asciidoctor/flathub-link-inline-macro/extension.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open-uri'
+
+class FlathubLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+  use_dsl
+
+  named :flathub
+  name_positional_attributes 'caption'
+
+  def process(parent, target, attrs)
+    doc = parent.document
+
+    # FlatHub API seems to have no documentation aside from the source code.
+    # You can easily infer the API with its source code at
+    # https://github.com/flathub/website.
+    app_id = target
+    app_metadata_uri = %(https://flathub.org/api/v2/appstream/#{app_id})
+
+    headers = {
+      'Accept' => 'application/json',
+      'User-Agent' => ::Asciidoctor::FoodogsquaredCustomExtensions::USER_AGENT
+    }
+
+    if attrs['caption'].nil?
+      metadata = OpenURI.open_uri(app_metadata_uri, headers) { |f| JSON.parse(f.read) }
+      attrs['caption'] = metadata['name']
+    end
+
+    url = %(https://flathub.org/apps/#{app_id})
+    doc.register :links, url
+    create_anchor parent, attrs['caption'], type: :link, target: url
+  end
+end

data/lib/asciidoctor/foodogsquared-extensions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+require_relative 'helpers'
+
+require_relative 'man-inline-macro/extension'
+require_relative 'swhid-inline-macro/extension'
+require_relative 'swhid-include-processor/extension'
+require_relative 'github-link-inline-macro/extension'
+require_relative 'github-raw-content-include-processor/extension'
+require_relative 'gitlab-link-inline-macro/extension'
+require_relative 'gitlab-raw-content-include-processor/extension'
+require_relative 'chat-block-processor/extension'
+require_relative 'git-blob-include-processor/extension'
+require_relative 'wikipedia-inline-macro/extension'
+require_relative 'package-indices-link-macro/extension'
+require_relative 'fdroid-link-inline-macro/extension'
+require_relative 'musicbrainz-link-inline-macro/extension'
+require_relative 'flathub-link-inline-macro/extension'
+require_relative 'repology-link-inline-macro/extension'
+require_relative 'ietf-rfc-link-inline-macro/extension'
+
+Asciidoctor::Extensions.register do
+  inline_macro ManInlineMacro
+  inline_macro IETFRFCLinkInlineMacro
+  block ChatBlock if @document.basebackend? 'html'
+
+  inline_macro SWHInlineMacro
+  include_processor SWHIDIncludeProcessor
+
+  inline_macro GitHubLinkInlineMacro
+  include_processor GitHubRawIncludeProcessor
+
+  inline_macro GitLabLinkInlineMacro
+  include_processor GitLabRawIncludeProcessor
+
+  include_processor GitBlobIncludeProcessor
+  preprocessor GitContentBranchAttributePreprocessor
+
+  inline_macro WikipediaInlineMacro
+
+  # Package indices
+  inline_macro CtanLinkInlineMacro
+  inline_macro PypiLinkInlineMacro
+  inline_macro CratesIOLinkInlineMacro
+
+  # App stores
+  inline_macro FDroidLinkInlineMacro
+  inline_macro FlathubLinkInlineMacro
+
+  # Databases
+  inline_macro MusicBrainzLinkInlineMacro
+  inline_macro RepologyLinkInlineMacro
+end

data/lib/asciidoctor/git-blob-include-processor/README.adoc

@@ -0,0 +1,68 @@
+= Git blob include processor
+:toc:
+
+
+An include processor that includes content from the current Git repo.
+The use case for this is specifically for creating dedicated branches for certain content.
+
+
+== Synopsis
+
+[source, asciidoc]
+----
+include::git:$REVSPEC[]
+----
+
+Where `$REVSPEC` is a revision as specified in link:https://manpages.debian.org/gitrevisions.7[gitrevisions.7].
+Take note this include processor only accepts a blob object's content to be extracted.
+This is meant to be used with other attributes.
+See <<Attributes>> for more details.
+
+If the resulting operation ends in an error (i.e., non-existing revision, file, something went wrong), it should log a warning and transclude an error.
+
+
+== Attributes
+
+- `path` is the filepath to be retrieved from the revision.
+When used with `diff`, it changes into a semicolon-delimited (`;`) list of files to make diffs with multiple files.
+
+- `context-lines` is the number of surrounding lines for the diff.
+This is only effective if `diff` option is given.
+
+- `other` is the other commit to be compared with.
+This is only effective if `diff` option is given.
+
+- `lines` get the specified lines from the path.
+It uses the same parser as the line specifier from link:https://docs.asciidoctor.org/asciidoc/latest/verbatim/highlight-lines/[highlighting select lines] so the syntax is the same.
+
+There's also a couple of link:https://docs.asciidoctor.org/asciidoc/latest/attributes/options/[options] for this component.
+You can give the following options through `opts` attribute (i.e., `opts="diff,reverse"`).
+
+- `diff` will show the difference in link:https://en.wikipedia.org/wiki/Diff[diff] format.
+
+- `reverse` reverses the sides to be compared.
+
+
+== Extra notes
+
+The extension is composed of two parts: an include processor and a preprocessor.
+
+The preprocessor add a document attribute, `doccontentref`, which it gives the Git reference for that content.
+`doccontentref` is the difference between the process working directory (`Dir.pwd`) and the base directory of the content to be converted.
+In case the process working directory is not entirely consistent for several reasons, you could give the attribute `rootdir` as the basis for the comparison.
+As another option, you could also manually set `doccontentref` in case it isn't applicable (i.e., for multilingual sites in Hugo projects).
+
+The include processor also accepts an empty target with the prefix (i.e., `include::git:[]`) as a shorthand for `include::git:{doccontentref}`.
+
+
+== Example usage
+
+The following examples assume that `doccontentref` points to `content/posts/sample`.
+
+- `include::git:HEAD[path=shell.nix]` should transclude the current iteration of `shell.nix`.
+
+- `include::git:{doccontentref}[opts="diff", path=Gemfile]` should include a diff of the Gemfile from `content/posts/sample` branch (assuming that Gemfile has changed).
+
+- `include::git:non-existing-rev[opts="diff"]` should result in a warning with the non-existing revision.
+
+- `include::git:{doccontentref}[path=README, lines=2..5]` should transclude the README file from lines 2-5.

data/lib/asciidoctor/git-blob-include-processor/extension.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'rugged'
+
+class GitBlobIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
+  def handles?(target)
+    target.start_with? 'git:'
+  end
+
+  def process(doc, reader, target, attrs)
+    repo = Rugged::Repository.discover(__dir__)
+
+    git_object_ref = target.delete_prefix 'git:'
+    git_object_ref = doc.attributes['doccontentref'] if git_object_ref.empty?
+
+    begin
+      git_object = repo.rev_parse git_object_ref
+
+      if attrs.key? 'diff-option'
+        options = {}
+
+        options[:paths] = attrs['path'].split(';') if attrs.key? 'path'
+        options[:context_lines] = attrs['context-lines'] if attrs.key? 'context-lines'
+        options[:reverse] = true if attrs.key? 'reverse-option'
+
+        if attrs.key? 'other'
+          other = repo.rev_parse attrs['other'] || nil
+          reader.push_include git_object.diff(other, **options).patch
+        else
+          reader.push_include git_object.diff(**options).patch
+        end
+      else
+        inner_entry = case git_object.type
+                      when :blob
+                        git_object
+                      when :commit
+                        git_object.tree.path attrs['path']
+                      when :tree
+                        git_object.path attrs['path']
+                      when :tag
+                        git_object.target.tree.path attrs['path']
+                      end
+
+        content = repo.lookup(inner_entry[:oid]).content
+
+        if attrs.key? 'lines'
+          content_lines = content.lines
+          new_content = +''
+          doc.resolve_lines_to_highlight(content, attrs['lines']).each do |line_no|
+            new_content << content_lines.at(line_no - 1)
+          end
+
+          content = new_content
+        end
+
+        reader.push_include content
+      end
+    rescue StandardError => e
+      reader.push_include "Unresolved directive for '#{target}' with the following error:\n#{e}"
+      warn e
+    end
+
+    reader
+  end
+end
+
+class GitContentBranchAttributePreprocessor < Asciidoctor::Extensions::Preprocessor
+  def process(document, reader)
+    base_dir = Pathname.new(document.base_dir)
+    rootdir = if document.attributes['rootdir'].nil?
+                Dir.pwd
+              else
+                document.attributes['rootdir']
+              end
+
+    document.attributes['doccontentref'] = base_dir.relative_path_from(rootdir).to_s
+    reader
+  end
+end

data/lib/asciidoctor/github-link-inline-macro/README.adoc

@@ -0,0 +1,49 @@
+= GitHub link inline macro
+:toc:
+
+
+An inline macro that easily links repositories from GitHub.
+
+
+== Synopsis
+
+[source, asciidoc]
+----
+github:$OWNER/$REPO[$CAPTION]
+----
+
+If caption is missing, the link text will be the namespace (i.e., `$OWNER/$REPO`) of the repo.
+
+
+== Attributes
+
+There are optional attributes for this macro.
+
+- `rev` is the commit/branch/tag of the repo to be linked.
+When given no caption, it will update the default caption with `$OWNER/$REPO@$REV`.
+
+- `path` is the filepath to be linked within the repo.
+
+- `issue` accepts the issue number to be linked in the GitHub repo.
+Take note `issue` is exclusive to other attributes and has more precedence.
+For example, if `issue` and `rev` are both present, the link for issue will be the result.
++
+When given no caption, it will update the default caption with `$OWNER/$REPO#$ISSUE`.
+
+You can also change certain behaviors with the link:https://docs.asciidoctor.org/asciidoc/latest/attributes/options/[options attribute].
+
+- `repo` sets the default link text with only the repo.
+Pretty useful to quickly refer to the name of the software.
+
+
+== Example usage
+
+- `github:foo-dogsquared/website[]` will link to link:https://github.com/foo-dogsquared/website[my website repository] with the link text `foo-dogsquared/website`.
+
+- `github:NixOS/nixpkgs[nixpkgs nixos-unstable branch, rev=nixos-unstable]` should link to the link:https://github.com/NixOS/nixpkgs/tree/nixos-unstable[NixOS unstable branch of nixpkgs] with a caption of `nixpkgs nixos-unstable branch`.
+
+- `github:errata-ai/vale[Vale v2.3.0 README, path=README.md, rev=v2.3.0]` should link to the link:https://github.com/errata-ai/vale/blob/v2.3.0/README.md[README of Vale v2.3.0].
+
+- `github:neovim/neovim[Neovim cannot open large files properly, issue=614]` should link to https://github.com/neovim/neovim/issues/614[an issue of Neovim] with `Neovim cannot open large files properly` as the link text.
+
+- `github:neovim/neovim[Neovim cannot open large files properly, issue=614, rev=master]` should still link to https://github.com/neovim/neovim/issues/614[an issue of Neovim] since `issue` has more precedence over `rev`.

data/lib/asciidoctor/github-link-inline-macro/extension.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+class GitHubLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+  use_dsl
+
+  named :github
+  name_positional_attributes 'caption'
+
+  def process(parent, target, attrs)
+    doc = parent.document
+
+    default_caption = if attrs.key?('repo-option')
+                        target.split('/').at(1)
+                      else
+                        target
+                      end
+    text = attrs['caption'] || default_caption
+    uri = URI.parse %(https://github.com/#{target})
+
+    if attrs.key? 'issue'
+      uri.path += %(/issues/#{attrs['issue']})
+      text << "##{attrs['issue']}" if text == target
+    else
+      uri.path += %(/tree/#{attrs['rev']}) if attrs.key? 'rev'
+      uri.path += %(/#{attrs['path']}) if attrs.key? 'path'
+      text << "@#{attrs['rev']}" if attrs.key?('rev') && text == target
+    end
+
+    target = uri.to_s
+
+    doc.register :links, target
+    create_anchor parent, text, type: :link, target: target
+  end
+end

data/lib/asciidoctor/github-raw-content-include-processor/README.adoc

@@ -0,0 +1,40 @@
+= GitHub raw content include processor
+:toc:
+
+
+This is a link:https://docs.asciidoctor.org/asciidoctor/latest/extensions/include-processor/[include processor] for easily including files from GitHub.
+Take note this will only include files.
+For directories, submodules, or symlinks: they will not be processed and a warning will be issued.
+
+This extension honors the link:https://docs.asciidoctor.org/asciidoctor/latest/safe-modes/[safe mode setting] and link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-uri/[the prerequisites for permitting includes with URI].
+
+The following is the basic form of using this include processor.
+
+[source, asciidoc]
+----
+\include::github:$OWNER/$REPO[]
+----
+
+
+== Extra notes
+
+The include processor will use GitHub API.
+It can create authorized requests by setting a token in `GITHUB_API_BEARER_TOKEN` environment variable.
+For instructions on how to get a token, you can refer to link:https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api?apiVersion=2022-11-28#authenticating[respective documentation].
+
+
+== Attributes
+
+- `path` for the path of the file to be included.
+This is practically required as the root entry of the repository is a directory.
+
+- `rev` is the name of the commit/tag/branch to be checked out.
+
+
+== Example usage
+
+- `include::github:asciidoctor/asciidoctor[path=README.adoc, rev=v2.0.0]` will include the Asciidoc file from the link:https://github.com/asciidoctor/asciidoctor/[Asciidoctor GitHub repo] from the point of `v2.0.0`.
+
+- `include::github:NixOS/nixpkgs[path=shell.nix]` will get the latest revision of `shell.nix` from link:https://github.com/NixOS/nixpkgs[nixpkgs repository].
+
+- `include::github:foo-dogsquared/nixos-config[]` should not be processed considering it points to the root directory of the repository.