Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Permalinks and fixes and conversions to several pages #1

Merged
merged 8 commits into from
Apr 11, 2024

Conversation

guilherme-gm
Copy link
Member

@guilherme-gm guilherme-gm commented Apr 7, 2024

This PR aims at doing some fixes and conversions.

Details:

  1. "Welcome to Hercules"
    Links were fixed, and the few extras that were in "Main Page" content was merged into it

    Preview

    image

  2. "Main Page" removed.
    This page represented the home of the old wiki ( https://wiki.herc.ws/wiki/Main_Page ). It is basically the same as "Welcome to Hercules" + Links, so I migrated a few things to "Welcome to Hercules" and deleted it

  3. Enabled "Permalink" option
    This gives every header a little "anchor" icon so we can share specific sections

    Preview

    image

  4. Replicated external-linked images into the repo
    There were some images uploaded by me and Annie that were linked somewhere else on Github (because Github wiki doesn't allow image upload). I've downloaded those and the repo now stores the images.

  5. Converted "Basics" and "Overview" sections to Markdown
    Most of it was done using Pandocs (more on that later), and a few manual adjustments. So it may not be perfect.

  6. Added Discord link to "Support" info in "About" page

  7. Removed non-Hercules pages in "Basic" section
    There were some pages that were not related to herc (Nexus, Multi Realm, and other things)

  8. Converted links to herc that were using http to https

Pandocs conversion

All the files above were converted using Pandocs, a tool made to convert between formats. Since most pages were still fully Mediawiki text, it did a pretty good job, but not perfect.

Most notable, page links and wikipedia links usually breaks. I fixed some with RegEx, but there are certainly others that are still broken.

I simply did a quick look over the converted content, so I will leave other links to be fixed as we go.

The following command was used:

pandoc \
    --preserve-tabs=true \
    --eol=lf \
    --wrap=auto \
    --columns=120 \
    --from mediawiki \
    --to gfm \
    --output docs/basics/zeny.md docs/basics/zeny.md

"main-page.md" is also removed and the relevant content merged into
"index.md", since both were meant to have the same info, but
"main-page.md" was part for the even older MediaWiki page
most of it was performed automatically via pandocs and with
a few RegExp's, so it is very likely that some things are still broken.
Those were docs where someone already had the work to update in our
Github Wiki, and provided working images, so copying those locally gives
us a centralized doc.
@guilherme-gm guilherme-gm merged commit 87924e0 into HerculesWS:master Apr 11, 2024
@guilherme-gm guilherme-gm deleted the fix-and-convert branch April 11, 2024 00:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants