From 6f75b4fae0463d057312c72fbb58d8a020525173 Mon Sep 17 00:00:00 2001 From: Martin Di Paola Date: Thu, 29 Nov 2018 00:27:32 +0000 Subject: [PATCH] Update links to docs; create an index with them --- README.md | 12 +++---- docs/advanced/unicode.md | 2 +- ...ow-to-support-new-finders-and-languages.md | 4 +-- docs/idx.md | 33 +++++++++++++++++++ docs/languages/python.md | 2 +- docs/{basic => overview}/differences.md | 0 docs/{usage => overview}/usage.md | 0 .../where-should-I-write-the-examples.md | 0 8 files changed, 43 insertions(+), 10 deletions(-) create mode 100644 docs/idx.md rename docs/{basic => overview}/differences.md (100%) rename docs/{usage => overview}/usage.md (100%) rename docs/{usage => overview}/where-should-I-write-the-examples.md (100%) diff --git a/README.md b/README.md index 395a8a6e..7d6937ec 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,9 @@ $ byexample -l python,ruby,shell README.md # run it # byexample: +skip ``` You can select which languages to run, over which files, how to display the -[differences](https://byexamples.github.io/byexample/differences) and much more. +[differences](https://byexamples.github.io/byexample/overview/differences) and much more. -The [usage](https://byexamples.github.io/byexample/usage) +The [usage](https://byexamples.github.io/byexample/overview/usage) document goes through almost all the flags that ``byexample`` program has, full of examples of course. @@ -106,10 +106,10 @@ an interpreter session like example. Take a look to the documentation of each language [docs/languages](https://github.com/byexamples/byexample/tree/master/docs/languages/). -Check out [where should I write the examples](https://byexamples.github.io/byexample/where-should-I-write-the-examples) +Check out [where should I write the examples](https://byexamples.github.io/byexample/overview/where-should-I-write-the-examples) section, it has a more in deep description. -And also check the [usage](https://byexamples.github.io/byexample/usage) page +And also check the [usage](https://byexamples.github.io/byexample/overview/usage) page for more examples. ## Languages supported @@ -148,8 +148,8 @@ It is possible to extend ``byexample`` adding new ways to find examples in a document and/or to parse and run/interpret a new language or adding hooks to be called regardless of the language/interpreter. -Check out [how to support new finders and languages](https://byexamples.github.io/byexample/how-to-support-new-finders-and-languages) -and [how to hook to events with concerns](https://byexamples.github.io/byexample/how-to-hook-to-events-with-concerns) for +Check out [how to support new finders and languages](https://byexamples.github.io/byexample/contrib/how-to-support-new-finders-and-languages) +and [how to hook to events with concerns](https://byexamples.github.io/byexample/contrib/how-to-hook-to-events-with-concerns) for a quick tutorials that shows exactly how to do that. You could also share your work and [contribute](https://github.com/byexamples/byexample/tree/master/CONTRIBUTING.md) to diff --git a/docs/advanced/unicode.md b/docs/advanced/unicode.md index f3de2e4b..886d4344 100644 --- a/docs/advanced/unicode.md +++ b/docs/advanced/unicode.md @@ -68,7 +68,7 @@ Differences: <...> ``` -**Note:** the [``ndiff`` algorithm](docs/basic/differences.md) +**Note:** the [``ndiff`` algorithm](docs/overview/differences.md) will not put the marker ``+`` in the correct position if the characters are *wide characters*. diff --git a/docs/contrib/how-to-support-new-finders-and-languages.md b/docs/contrib/how-to-support-new-finders-and-languages.md index 33e10ca0..3e73be32 100644 --- a/docs/contrib/how-to-support-new-finders-and-languages.md +++ b/docs/contrib/how-to-support-new-finders-and-languages.md @@ -31,7 +31,7 @@ The first thing to teach ``byexample`` is how to find a ``ArnoldC`` example. ``byexample`` already has a generic finder, the -[fenced code block finder](docs/usage/where-should-I-write-the-examples.md). +[fenced code block finder](docs/overview/where-should-I-write-the-examples.md). But just for fun, let's imagine that we want to do something different. Let's say that our examples are enclosed by the ``~~~`` strings: anything @@ -148,7 +148,7 @@ part of the example: ``` Check also how this is -[seen and used](docs/usage/where-should-I-write-the-examples.md) +[seen and used](docs/overview/where-should-I-write-the-examples.md) by the user of your new language. ### Detect the language diff --git a/docs/idx.md b/docs/idx.md new file mode 100644 index 00000000..7c42a58b --- /dev/null +++ b/docs/idx.md @@ -0,0 +1,33 @@ +# Quick Overview +[Quick usage](docs/overview/usage.md) +[Where should I write the examples?](docs/overview/where-should-I-write-the-examples.md) +[Showing the Differences](docs/overview/differences.md) + +# Basics Options +[Byexample Options](docs/basic/options.md) + +[Setup and Tear Down](docs/basic/setup-and-tear-down.md) +[Capture and Paste](docs/basic/capture-and-paste.md) +[Skip and Pass](docs/basic/skip-and-pass.md) +[Example Timeout](docs/basic/timeout.md) +[Normalize Whitespace](docs/basic/normalize-whitespace.md) + +# Advanced Options +[Terminal Geometry](docs/advanced/geometry.md) +[Greedy and Lazy Tags](docs/advanced/greedy-lazy-tags.md) +[Shebang](docs/advanced/shebang.md) +[Terminal Emulation](docs/advanced/terminal-emulation.md) +[Unicode Support](docs/advanced/unicode.md) + +# How to Contribute +[Add New Languages](docs/contrib/how-to-support-new-finders-and-languages.md) +[Hook to Events](docs/contrib/how-to-hook-to-events-with-concerns.md) +[Contribute Guidelines](https://github.com/byexamples/byexample/tree/master/CONTRIBUTING.md) + +# Languages Supported +[Python](docs/languages/python.md) +[Ruby](docs/languages/ruby.md) +[Javascript](docs/languages/javascript.md) +[Shell](docs/languages/shell.md) +[GDB](docs/languages/gdb.md) +[C/C++](docs/languages/cpp.md) diff --git a/docs/languages/python.md b/docs/languages/python.md index 717010b1..5e6653c9 100644 --- a/docs/languages/python.md +++ b/docs/languages/python.md @@ -209,7 +209,7 @@ See [norm-ws](docs/basic/normalize-whitespace.md), [tags](docs/basic/capture-and-paste.md), [skip](docs/basic/skip-and-pass.md), [pass](docs/basic/skip-and-pass.md) and -[diff](docs/basic/differences.md) for more info. +[diff](docs/overview/differences.md) for more info. ## Pretty print display hook diff --git a/docs/basic/differences.md b/docs/overview/differences.md similarity index 100% rename from docs/basic/differences.md rename to docs/overview/differences.md diff --git a/docs/usage/usage.md b/docs/overview/usage.md similarity index 100% rename from docs/usage/usage.md rename to docs/overview/usage.md diff --git a/docs/usage/where-should-I-write-the-examples.md b/docs/overview/where-should-I-write-the-examples.md similarity index 100% rename from docs/usage/where-should-I-write-the-examples.md rename to docs/overview/where-should-I-write-the-examples.md