Jump to content
Please Use CODE Tags

GitHub Wiki vs HTML based Documentation

AlTech
By AlTech
in Programming
 Share

POLL  

11 members have voted

  1. 1. How would you make documentation

    • GitHub Wiki
      5
    • HTML based documentation
      4
    • Other
      2

Posted

Hi guys,

one of my projects (namely AluminiumCore) requires a lot of documentation and I'm not sure how to present documentation.

 

Here are my options:

  • GitHub Wiki
  • HTML based documentation

 

GitHub wiki is clean and relatively simple but it's hard to customize. HTML based documentation is clean, easy to customize but it's quite a hassle to do.

 

If you had to pick one, which one would you choose?

Judge a product on its own merits AND the company that made it.

How to setup MSI Afterburner OSD | How to make your AMD Radeon GPU more efficient with Radeon Chill | (Probably) Why LMG Merch shipping to the EU is expensive

Oneplus 6 (Early 2023 to present) | HP Envy 15" x360 R7 5700U (Mid 2021 to present) | Steam Deck (Late 2022 to present)

 

Mid 2023 AlTech Desktop Refresh - AMD R7 5800X (Mid 2023), XFX Radeon RX 6700XT MBA (Mid 2021), MSI X370 Gaming Pro Carbon (Early 2018), 32GB DDR4-3200 (16GB x2) (Mid 2022

Noctua NH-D15 (Early 2021), Corsair MP510 1.92TB NVMe SSD (Mid 2020), beQuiet Pure Wings 2 140mm x2 & 120mm x1 (Mid 2023),

Link to comment
Share on other sites
Link to post
Share on other sites
Posted

I'm primarily a web dev, I can easily chuck together some extremely tidy and concise documentation. If you're not familiar with basic HTML/CSS and maybe some JS if you want to get fancy, for example if you're a C# dev, it might just be better for everyone to use github

I am good at computer

Spoiler

Motherboard: Gigabyte G1 sniper 3 | CPU: Intel 3770k @5.1Ghz | RAM: 32Gb G.Skill Ripjaws X @1600Mhz | Graphics card: EVGA 980 Ti SC | HDD: Seagate barracuda 3298534883327.74B + Samsung OEM 5400rpm drive + Seatgate barracude 2TB | PSU: Cougar CMX 1200w | CPU cooler: Custom loop

Link to comment
Share on other sites
Link to post
Share on other sites
Posted

If you really don't like GitHub, it is rather simplistic; try mediaWiki, wikipedia's engine. IMO some blogs, and API documentation I land on could be better served with mediawiki than wordpress

             ☼

ψ ︿_____︿_ψ_   

Link to comment
Share on other sites
Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share
Go to topic listing Programming

×