@datacamp/rdocs-light

1.0.11 • Public • Published

rdocs-light

Embeddable RDocumentation widget

Widget Image

How does it work?

Html elements with the data-mini-rdoc attribute will show a tooltip with information when hovered over. The value of the attribute should be of the form package::topic or just package. The version of the package can also be defined with the optional data-mini-rdoc-version attribute.

If the version attribute is not provided:

  • For a package the documentation for the latest version of that package will be shown.
  • For a topic the documentation for the topic in the latest version of the package (which contains the topic) will be shown.

How to use?

  • Load rdocs-light.min.js in your webpage.
  • Call rdl.initRDocsLight(options); on page load

Auto Link to RDocumentation

  • Tags with the data-mini-rdoc attribute can be automatically changed to link to the documentation.
  • Can also be used standalone (without initiating RDocsLight)
  • Call rdl.autoLink();

Options

Container

  • The DOM element the library searches through
  • Default to the body of the page
  • Option name: container

Auto Pinning

  • Whether or not the widget is pinned automatically.
  • Defaults to false
  • Option name: autoPin

Pin on click

  • Whether or not the widget is pinned when the user clicks on the widget.
  • Defaults to true
  • Option name: pinOnClick

Show Widget also for Rdoc Links

Set top offset

  • If there is a fixed element positioned at the top of the scrollable element, you can set the offset
  • Defaults to 0
  • Option name: topOffset

Show Usage Section For Topics

  • Whether or not to show the usage section in the widget
  • Default to false
  • Option name: showTopicUsageSection

Show Arguments Section For Topics

  • Whether or not to show the arguments section in the widget
  • Default to false
  • Option name: showTopicArgumentsSection

Examples

You can find examples in the example folder in the repository.

Building

  • After you downloaded this repository, run npm install for all the necessary dependencies.
  • Create a .env file in which you define all environment variables. See .env.example for all variables that need to be defined. For example, if you also run the RDocumentation-app local, you will have to set API_BASE_URL to http://localhost:1337.
  • Afterwards you can use npm run dev to build RDocs Light and node web.js to serve random examples with local build on http://localhost:3003/.

Readme

Keywords

none

Package Sidebar

Install

npm i @datacamp/rdocs-light

Weekly Downloads

6

Version

1.0.11

License

MIT

Last publish

Collaborators

  • acmpires
  • hugo.correia.dc
  • jessestell
  • almeida-datacamp
  • wilant
  • patryk.szulczyk
  • ruben-datacamp
  • martinchio
  • dc-eriktisme
  • ruiguedes
  • olivierkamers
  • franaviladc
  • gui.cabral
  • datacamp-machine-user
  • tomaszwisniewski
  • pedro-carmona-datacamp
  • alanhughesdatacamp
  • datacamp-paulomonteiro
  • marcinnaglik
  • zpieslak
  • vvankrunkelsven
  • evertet
  • marbdq-dc
  • mzetea
  • frederikvg
  • nhlongnguyen
  • bobby.clare
  • cdalby
  • luigi-dintrono-dc
  • eoliveiradc
  • berndschrooten
  • _bogdan_floris_
  • denathoxhadc
  • sajtempler-dc
  • bartlens
  • filipsch
  • meehirpateldatacamp
  • ztsorojev
  • smidge
  • joachimzeelmaekers
  • garyalway
  • jdmunro
  • close-d-dev
  • herve-eerebout
  • dandenney
  • ewaldbervoets
  • rikbw
  • abordanpeter
  • aarondc
  • hermansje
  • nunorafaelrocha
  • nickvdyck
  • timsangster
  • tuur
  • lipsumar
  • caterina
  • chrisramakers
  • ppetermann
  • springerigor
  • iryna059
  • louiejakebell
  • kogitoja
  • larisa-datacamp
  • samwooler
  • forvalho
  • bruno.datacamp
  • marcin-data
  • julienbenaouda