hugo-future-imperfect icon indicating copy to clipboard operation
hugo-future-imperfect copied to clipboard

Create Wiki

Open pacollins opened this issue 7 years ago • 6 comments

Need some opinions on this. Should we keep the README.md clean and more descriptive and move things like explaining shortcodes/features to the Wiki, OR just make the README.md cleaner, OR just make a post within the example site showcasing them all?

pacollins avatar Oct 25 '17 23:10 pacollins

I think cleaning up the README.md and moving shortcodes/features to the wiki is a good idea. Adding a post (similar to the markdown cheat sheet posts on most themes) showing off the shortcodes wouldn't be a bad idea either.

BernCarney avatar Nov 20 '17 03:11 BernCarney

Thanks for your input. So you think that utilizing the wiki with images would be better/more appropriate than putting it in the demo site that Hugo hosts?

pacollins avatar Nov 20 '17 03:11 pacollins

I think more examples and detailed information in a Wiki would be helpful. Of course an example site may be even more helpful, but it may be hard to provide "all the examples" in a single page, especially if there would be mutually exclusive design choices.

So probably do both. ;)

(Ps: I personally would be interested atm in multi-language, multi-menu and fancybox examples.)

henningsway avatar Dec 25 '17 13:12 henningsway

@henningsway - Realizing I am replying ridiculously late. ML is almost done. MM is stale. Fancybox can be seen here.

pacollins avatar Feb 09 '18 03:02 pacollins

I think the wiki will help for the non-technical users.

johnatasjmo avatar Jul 11 '18 00:07 johnatasjmo

Howdy,

I was actually just thinking about this as I was trying to navigate the README.md. I personally prefer using the README for things like basic installation and maybe contribution guidelines. Everything else would be better-off in the Wiki. This way, the readme is less cluttered and everything else can be organized into a structure that makes sense and is easy to navigate in the Wiki.

Let me know if you would like some help in organizing the content. I would be happy to help!

daberg2 avatar Aug 03 '19 17:08 daberg2