Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.29 KB

README.md

File metadata and controls

72 lines (52 loc) · 2.29 KB

term

Definition

Term refers to...

History

How would we direct a user to a question about the term history? Here is an example of a question embedded into the text, not that it starts with "question" to indicate being a question, and that all letters are lowercase and separated with "-" and no spaces. The GitHub checks provided will ensure this is maintained with each push to master. When the server imports the updated content, it will discover this question and index it.

"Term" was first used when someone wrote it in this GitHub repository. That someone might have been a dinosaur.

Examples

It's helpful to provide examples for the user, and we can do this in several ways:

  • code blocks labeled with spans
  • files in an included examples folder in the repository referenced with a relative link
  • external urls included in links with an id that starts with "example-"

Currently, we just support the first - using a single embedded code block, and I'll be added the other two use cases as more testing and feedback is given.

Code blocks

Here is a code block that is labeled as an example. The AskCI server will index the location in the text, and also extract the example in the next code block. You are limited to one code block for this case.

echo "This is an example"

References