JP Simard
JP Simard
None to report.
@yoshyosh what do you think needs to be done for this?
> @mrh-is may be helping with jazzy fixes as well. We will be discussing more tomorrow. :smile: :smile: :smile:
> Do we still have plans to do any of this? Maybe? This is such a fuzzy request, it's hard to say exactly when this would be "complete" or even...
jazzy looks for one of `README.md`, `README.markdown`, `README.mdown` or `README` (in that order) in the directory from where it run to render the index page at the root of the...
I definitely agree that jazzy needs much more usage documentation. In the meantime, you can do the opposite for now: run jazzy from the root directory with the `--source-directory DIRPATH`...
The answer is essentially [Markdown](http://daringfireball.net/projects/markdown/syntax). GitHub also has a good guide: https://help.github.com/articles/markdown-basics/. Links to other code declarations aren't yet supported, but planned (see #13). Function parameters and return values, however...
No, there's a ton we could do to not just teach users how to use Jazzy, but how to even write standard Objective-C or Swift documentation comments. Linking to Erica...
Absolutely, thanks for filing this.
@lloydsargent can you share an example output from your theme? Why not make a PR adding it to jazzy?