raddocs icon indicating copy to clipboard operation
raddocs copied to clipboard

How can i add more custom text?

Open andreasklinger opened this issue 11 years ago • 4 comments

I would like to add an welcome text to the api docs Maybe more details explainations to the examples

Are there ways to do that? (unsure if this is raddocs or rspec_api_documentation related)

Btw ApiToMe offers a apitome.md as a welcome text placeholder

andreasklinger avatar Jul 09 '14 12:07 andreasklinger

This should be asked in the rspec_api_documentation repo :)

mrcasals avatar Aug 04 '14 08:08 mrcasals

fair enough - sorry :)

i added it here because apitome solved this through an own file

if somebody finds this via google: i "solved" my problem by adding an '1_hello_spec.rbwithexplanation` calls within the empty example ;)

andreasklinger avatar Aug 04 '14 08:08 andreasklinger

I think they are both involved. Raddocs still needs to know to parse the markdown file.

oestrich avatar Aug 04 '14 12:08 oestrich

Yeah, but first rspec_api_documentation needs to implement this, right? :)

mrcasals avatar Aug 04 '14 13:08 mrcasals