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

Using highlight line causes embedded code to disappear #2

Closed
leoj3n opened this issue Apr 7, 2017 · 2 comments
Closed

Using highlight line causes embedded code to disappear #2

leoj3n opened this issue Apr 7, 2017 · 2 comments

Comments

@leoj3n
Copy link
Contributor

leoj3n commented Apr 7, 2017

image

Used like:

This is because that plugin provides the extremely common task of processing "tags". A tag is an identifier, usually embedded in source code comments, that provides documentation or information about some functionality, inline in the source code itself. Some of the many default tags are `@@function @@parent @@description @@body`, used in a source-file like:

```js
/**
 * @@function yourproject.hellofunc hellofunc
 * @@parent YourProject.apis
 * @@description

 * This documents something in a sub-page of YourProject.
 *
 * @@body
 *
 * ## Usage
 *
 * Explain how to use it in _markdown_!
 */
```

@highlight 2,2

For an example of a processor plugin that's not included by default, see:
@leoj3n
Copy link
Contributor Author

leoj3n commented Apr 7, 2017

I see the docs say "Needs to be used after bit-docs-prettify." but it's not clear how to do so?

@leoj3n
Copy link
Contributor Author

leoj3n commented Apr 7, 2017

It seems what is meant is putting bit-docs-html-highlight-line after bit-docs-prettify in package.json. Didn't realize bit-docs respects the ordering there.

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

1 participant