question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

create robust, attractive docs

See original GitHub issue

The readme feels very bloated because of the huge asciicinema.org images. We should convert them to .gif images to fix this, and we can still link to asciicinema.org if you want.

To avoid overwhelming new users, it may be worth moving most of the examples to the Wiki, but that’s up to you.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:10 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
mateodelnortecommented, Jun 14, 2019

https://docusaurus.io looks pretty great. Here are a few example docs sites I think are great, and we could emulate:

Anyone else have a style they want to point out?

2reactions
aleclarsoncommented, Dec 11, 2018

I highly recommend https://docusaurus.io which is what Babel, Jest, etc use.

edit: Oh it’s even maintained by Facebook: https://github.com/facebook/Docusaurus

Read more comments on GitHub >

github_iconTop Results From Across the Web

All you need to know about creating robust design docs
All you need to know about creating robust design docs. Image of a pencil on a notebook. Photo by Jan Kahánek on Unsplash....
Read more >
Beautiful Documents - Windward Studios
This e-book helps you create beautiful and effective documents. In it, we serve up tips and techniques on how to design documents that...
Read more >
10 Neat Ways to Create Beautiful Google Documents
10 Neat Ways to Create Beautiful Google Documents · 1. Paragraph Styles+ · 2. Lucidchart Diagrams · 3. Translate · 4. Magic Rainbow...
Read more >
How to design your docs to shine like a diamond - Coda
How to design your docs to shine like a diamond. Ideas on how to make your Coda docs beautiful using page layout.
Read more >
How to Make a Document Look Professional In 15 Steps
A company is only as good and respected as the paper it's represented on. Here's how to make a document look professional in...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found