Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 4.5 KB

README.md

File metadata and controls

74 lines (44 loc) · 4.5 KB

header auth=github background=wc:Box_of_type.jpg height=100 no-manifest-popover
- [Help](https://docs.juncture-digital.org)
- [Workbench](/wb)

Juncture

Juncture is a tool for creating and displaying interactive web pages. Juncture web pages are created using an extended version of the Markdown language. Markdown is a lightweight markup language that is widely used to add formatting elements to plain text. Juncture extends Markdown with the addition of a few custom tags enabling interactive viewers to be easily added to a generated web page. Juncture uses GitHub for storing the Markdown files.

Getting Started

To begin using Juncture you will need a GitHub account and some basic familiarity with Markdown.

GitHub is a free Internet hosting service commonly used for software development projects. It provides sophisticated features for version control and workflow management for distributed teams. Juncture primarily uses GitHub as a file hosting service, similar to how one might use Dropbox or Google Drive. The Markdown files that Juncture uses to render interactive web pages are stored in GitHub.

Markdown is a simple language and a basic understanding of usage can be obtained in just a few minutes. Below are some resuources for learning Markdown.

Creating your first Juncture essay

Create and configure a Juncture-enabled Github repository

  1. Create a Juncture-enabled Github repository using this link - https://github.com/juncture-digital/template/generate
  • Enter a Repository name (e.g,, "essays") and optional Description.
  • Press Create Repository
  1. In the newly created repository, enable Github Pages by selecting Pages from the Code and automation section in the repository Settings page. In the Pages form select main from the Branch pull-down menu and press Save.

Create a new Markdown file to use for the Juncture essay

  1. In the newly created repository, create a new markdown file for the Juncture essay by selecting Create new file from the Add file pull-down menu located on the repository home page.
  2. In the file name input field enter "sunflower/README.md"
  3. In the editor field add the text [![](https://v3.juncture-digital.org/images/wb.svg)](https://v3.juncture-digital.org/wb)
  4. Press the Commit changes... button located at the top-right of the page.

Add Markdown text for your essay

At this point you should have a new repository with a README.md file located in a folder named sunflower.

To add Juncture Markdown text for the essay you may continue to use the Github editor or use the editor provided in the Juncture Workbench. The Juncture Workbench editor is recommended as it provides a preview toggle for rapidly making and viewing changes. The instructions in this Getting Started guide assume the Juncture editor is being used.

To access the workbench, press the two-toned "Juncture Workbench" button now displayed at the top of the Markdown file when viewing from the Github site. The first time the Workbench editor is used you'll be asked to authorize Juncture to access your repository.

Append the following text to your sunflower/README.md file, leaving a blank line between the workbench button text added in the previous step and this new text.

# Common Sunflower

`image wc:Sunflower_sky_backdrop.jpg .right`

The [common sunflower](Q171497) is a species of large annual forb of the daisy family Asteraceae. The common sunflower is harvested for its edible oily seeds which are used in the production of cooking oil.

Alternately, use the following text for a side-by-side essay layout using the original Juncture tagging syntax.

<param ve-config title="Sunflower" banner="wc:Sunflower_sky_backdrop.jpg">

The [common sunflower](Q171497) is a species of large annual forb of the daisy family Asteraceae. The common sunflower is harvested for its edible oily seeds which are used in the production of cooking oil.
<param ve-image manifest="wc:Sunflower_sky_backdrop.jpg">

After adding the new text, press the preview button located in the workbench toolbar.