Citation Example

This page demonstrates how to use citations and bibliography in your documentation.

What are Citations?#

Citations are references to external sources within your documentation. They allow you to attribute ideas,data,and quotes to their original authors ^[1].

Using REST APIs#

The REST architectural style ^[2] provides a scalable approach to building web services. RESTful APIs have become the standard for web development.

Data Format#

JSON (JavaScript Object Notation) ^[3] is a lightweight data format that has become ubiquitous in modern APIs and web applications.

Benefits of Citations#

• Credibility — Show your sources and give credit
• Academic Rigor — Meet academic and professional standards
• Traceability — Readers can find the original sources
• Professional — Demonstrates thorough documentation

How It Works#

1. Define your bibliography in the frontmatter (YAML format)
2. Reference citations with ^[4] in the markdown
3. The system automatically converts them to numbered references
4. Bibliography appears at the end with full details

Multiple Authors#

Citations can have multiple authors ^[1],which will be formatted correctly in the bibliography.

The citation feature is perfect for:

• Technical documentation with references
• Academic papers and research
• API documentation with industry standards
• Best practices guides with citations