Github wiki importer?

[mperham]

Hello, I've been using bridgetown for the last few days and have been quite impressed! Really nice work, Jared and crew!

I want to regain a little bit of digital independence by moving Sidekiq's wiki off GitHub Wiki and move the content to my new bridgetown-based sidekiq.org. Ideally content at github.com/sidekiq/sidekiq/wiki will map directly to sidekiq.org/wiki.

I found a Jekyll plugin which does 99% of the migration and will allow manual syncs so one can continue authoring the content in the github wiki UI and pull content updates from it.

https://github.com/djacquel/WikiToJekyll

It pulls in the github wiki content as a git submodule, pulls the latest content, parses the markdown, swaps any links and renders the markdown content as usual.

Does anything like this exist for Bridgetown? The code's a little hacky but it's pretty small, just two files.

PS the new Bridgetown-powered site is in beta at https://sidekiq.contribsys.com with source at https://github.com/sidekiq/site.

[jaredcwhite]

Hi @mperham, thanks for the positive feedback!

Yeah so wiki-style content is a priority for v2.1 (in beta) and definitely the upcoming v2.2. We added a builtin plugin for loading Markdown content from external sources which would be a good basis for your wiki. Wouldn't handle the git pull directly, but I'm sure you could write Rake task or something to do that. https://beta.bridgetownrb.com/docs/content/external-sources

I'm behind in getting 2.1 beta 2 released with a necessary bugfix, but should be any day now and then it'd be worth checking out.

[mperham]

I've got the wiki .md files in src/_wiki. I've set up my init:

  collections do
    wiki do
      output true
      # Using a `:path.*`-style permalink is recommended to ensure links between
      # Markdown files work as intended:
      permalink "wiki/:path.*"
    end
  end

  config.defaults << {
    scope: {collection: :wiki},
    values: {layout: :default}
  }

  init :external_sources do
    contents do
      wiki "src/_wiki"
    end
  end

All I get in output/wiki is a copy of the .md files. I want them to be rendered to .html, how do I do that?

[jaredcwhite]

@mperham That mostly looks right but I think you'd want the wiki to live outside of src...what's probably happening is the normal collection reader and the external sources reader are in conflict with each other. Maybe just put a wiki folder in the project root?

[mperham]

Hmm. When I do that, it doesn't import the wiki pages at all. .md files in _wiki/.

  init :external_sources do
    contents do
      wiki "_wiki"
    end
  end

No output/wiki directory at all.

[jaredcwhite]

@mperham I tried a local example, and it should work if it's called wiki without the underscore. (The underscore is just for collections inside of src, otherwise in general any folder starting with an underscore is ignored when files are read in.)

Also the issue with the sitemap plugin should get cleared up next week.

[mperham]

Yep, removing the underscore makes it work. Thanks, it’s working now!