Skip to content
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

How can i add more custom text? #23

Open
andreasklinger opened this issue Jul 9, 2014 · 4 comments
Open

How can i add more custom text? #23

andreasklinger opened this issue Jul 9, 2014 · 4 comments

Comments

@andreasklinger
Copy link

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

@mrcasals
Copy link

mrcasals commented Aug 4, 2014

This should be asked in the rspec_api_documentation repo :)

@andreasklinger
Copy link
Author

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 ;)

@oestrich
Copy link
Contributor

oestrich commented Aug 4, 2014

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

@oestrich oestrich reopened this Aug 4, 2014
@mrcasals
Copy link

mrcasals commented Aug 4, 2014

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants