Skip to content

Why not to use GitHub Wiki.

License

Notifications You must be signed in to change notification settings

MarkedDown/Wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Wiki

Why not to use the GitHub Wiki feature.


Problems

Folders

Wiki pages cannot be sorted into folders
and thus they inevitably become a mess.

Links

Relative links to for example images don't work
on wiki pages, this means you will end up with
markdown cluttered full of long absolute links.

Contributing

Wikis have a separate version history
and cannot easily be contributed to
as you would to a normal repository.



Alternative


Recommended

Simply create a  /Documentation/  folder.


Branches

If you want to separate the documentation completely
you may want to create a Documentation branch.


Enterprise

In case you have a lot of documentation and
yourrepository is part of an organization, you
could also create a dedicated repository for it.