Curvenote Docs

Internal References

Curvenote makes it easy to add reference links to the content throughout your project. Specialized internal references are included for articles, notebooks, sections, figures, and equations. Using either the command menu options or the direct keyboard shortcuts a list will appear of your available content to select and reference. When you hover over a reference, a preview of that content will appear.

#Referencing Commands

You can use either the command menu or keyboard shortcuts to reference content within your text.

#Command Menu

When using the command menu / you will need to first search the command menu options for the reference style you want, then click or hit enter to select that option. From there, you can either scroll through or continue typing to search for the content you want to reference. To insert the reference either click on the option, or hit enter when the option is highlighted.

#Keyboard Shortcuts

When using the keyboard shortcuts, you can either begin typing [[, then scroll through or continue typing to search through all of your available content. You can also narrow your search by content type by entering the specified shortcut commands for each content type below. From here you can again scroll or continue typing to search. To insert the reference either click on the option, or hit enter when the option is highlighted.

#Articles and Notebooks

Articles and notebooks can be referenced throughout your text using the commands below. Only articles or notebooks within the current project will be displayed in the search options when using these reference commands.

To reference an article:

/link to article [[article:

To reference a notebook:

/link to notebook [[nb:

#Sections

You can create sections within your articles and notebooks by using Markdown heading formatting. Learn more about creating headings ➡️ Command Menu & Shortcuts, Markdown Accelerated Editing

Once headings have been been created, you can update their size and add numbering by highlighting the full text of the heading. A toolbar will appear below the text. You can adjust the level of your heading in the drop down menu. You can Toggle Numbering by clicking on the number symbol. The numbering is ordered by the level and location of the heading on the page. All numbering will start at 1 at the beginning of the page. The numbering will automatically update with added or removed headings.

Currently only sections that are numbered can be referenced accurately. Only sections on the current page will be displayed in the search options when using these reference commands. To reference a section:

/link to section [[sec:

#Figures

Images, GIFs, and Jupyter Outputs that are numbered can be referenced. Only figures on the current page will be displayed in the search options when using these reference commands. Learn more about numbering figures in Figures & Images.

To reference a figure:

/link to figure [[fig:

#Equations

Equations that are numbered and on the current page will be displayed in the search options when using these reference commands. Learn more about numbering equations Math & Equations.

/link to equation [[eq: