Other miscellaneous improvements

[TheAngryByrd]

Hey 👋 . I had a list of other things I noticed would be good for nacara to have but forgot to post them.

Other thoughts

• Search
• Versioning
  • Be nice to know which version this documentation is generated for (based on git-tag or something similar)
• Current documentation page should have a link to the file on github so people can easily send a PR to fix the documentation
• Be nice to generate topnav/footer with project data, such as README, CHANGELOG/Release Notes, License, Code of Conduct, etc.
• Toggleable to dark mode

See: https://www.jimmybyrd.me/miniscaffold-docs-test/Api_Reference/miniscaffold-docs-test/miniscaffold_docs_test-say.html for examples of some of these.

[MangelMaxime]

Thank you for the proposition.

Current documentation page should have a link to the file on github so people can easily send a PR to fix the documentation

There is an Edit link at the top right of the page.

In the past, it more visible but I got some feedback asking to make it more discrete.

Toggle able to dark mode

Indeed, I never did it but I think Bulma has support for light/dark mode now.

I am unsure of how much work it is.

Be nice to generate topnav/footer with project data, such as README, CHANGELOG/Release Notes, License, Code of Conduct, etc.

I had a hard time finding ideas about what to place in the footer. Thanks you for the ideas.

Right now there are no configuration property for the footer because of that. But the footer is using the partial systems of Nacara. This means that you can write any HTML and have it render there.

Nacara/docs/_partials/footer.jsx

Lines 1 to 13 in 33dc6c6

	import React from 'react';
	const year = new Date().getFullYear();
	export default (
	<div className="content has-text-centered is-size-5">
	<p>
	The content of this website is copyright © {year}
	<br />
	under the terms of the <a className="is-underlined" href="https://github.com/MangelMaxime/Nacara/blob/master/LICENSE.txt" style={{color: "white"}}>MIT License</a>
	</p>
	</div>
	)

I will work on adding a configuration property for the footer content in a future version of Nacara.

[TheAngryByrd]

Thanks for the reply!

[MangelMaxime]

I made a footer.jsx looks ok for a generic version.

Example of the source code:

https://github.com/elmish/browser/blob/040588771350216cde17781dc0e2917130d01f26/docs/_partials/footer.jsx

The file needs some SCSS rules too:

https://github.com/elmish/browser/blob/040588771350216cde17781dc0e2917130d01f26/docs/style.scss#L99-L153

I think this kind of footer can be configured via JSON and people can always include a footer.jsx if they want their own footer.

[MangelMaxime]

With the rework of Nacara I am tracking the footer work in #180