-
Notifications
You must be signed in to change notification settings - Fork 57
Add ability to describe an introduction text #256
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
Comments
If we want to add an introduction text, we will probably keep it very simple: a string parsed as Markdown, injected into the DOM. I'm okay with that. Edit: depending on the outcome of this issue, we'll move it to sassdoc-theme-default since it is strictly related to the theme at this point. |
Maybe we could even allow to include a README.md right from the project root. |
I think a choice of either the |
I don't like this. I don't want people to write their README in some way because of SassDoc. Although we could allow either a markdown file (if string is a path), or a description as a string directly. |
Adding the ability to put a path in the configuration file is fine with me. Do we move this to the default theme? |
@valeriangalliat, @pascalduez, okay? |
Yep. |
A path in config is fine. Let's go ! |
Alright, so the scenario is:
Who takes it? I can take the theme/docs stuff. |
Or you probably mean |
You get the idea. If it's a path, get content, else treat content as content. |
Regarding this (part of 2.1), there is something I don't like much. When taking an actual |
What would be the best way to tackle this one? I'm thinking of:
Thoughts @SassDoc/owners? |
Looks perfect. Exactly what I had in mind. |
It's a theme feature. |
It would be great to be able to add an Introduction to the documentation. just something to sit above the generated docs in the main column (in the default theme).
If I have a README outlining how the library should be used and full of examples, it would seem to me this should be something that I can include into the docs as an introduction. I'd love to be able to just direct to the Sassdoc from the README, but pure docs without context mean I'm going to end up boiling a lot of the docs down into the README. Being able to consolidate intro and docs would make both docs and introduction stronger.
This could be expanded to allow links from the intro to the relevant docs (perhaps just parsing out known entities from the text and adding links automagically).
The text was updated successfully, but these errors were encountered: