Improve example

Correct README

Improve example

Correct README
This commit is contained in:
Dunya Kirkali 2024-07-07 23:12:19 +02:00
parent 3eac5aecc4
commit 64fbe7fe90
6 changed files with 26 additions and 20 deletions

View File

@ -4,6 +4,12 @@ Gutenberg the 💩 out of it!
<img src="figures/gutenberg.jpg" width=530> <img src="figures/gutenberg.jpg" width=530>
Letterpress is a project aimed at simplifying the self-publishing process for books. It provides a ready-to-use template based on AsciiDoctor, catering to authors who need robust support for diagramming, coding examples, and mathematical formulas.
## Contributing
Contributions to Letterpress are welcome! If you have suggestions, improvements, or bug fixes, please fork the repository and submit a pull request.
## Tools ## Tools
This Project makes use of the following tools: This Project makes use of the following tools:
@ -36,13 +42,13 @@ make
If you just need to generate the PDF: If you just need to generate the PDF:
```bash ```bash
make output/your_book_slug.pdf make output/book.pdf
``` ```
If you just need to generate the EPUB: If you just need to generate the EPUB:
```bash ```bash
make output/your_book_slug.epub make output/book.epub
``` ```
### Count ### Count

View File

@ -12,7 +12,7 @@ image::mountains.jpg[Mountains, width=600, align=center]
==== Mountain Formation ==== Mountain Formation
Mountains are formed through various geological processes, including tectonic activity and volcanic eruptions. The Himalayas, for instance, were formed by the collision of the Indian and Eurasian tectonic plates. Mountains are formed through various geological processes, including ((tectonic)) activity and volcanic eruptions. The Himalayas, for instance, were formed by the collision of the Indian and Eurasian tectonic plates.
. Types of Mountains . Types of Mountains
* Fold Mountains * Fold Mountains
@ -29,7 +29,7 @@ image::beach.jpg[Beach, width=600, align=center]
==== Marine Life ==== Marine Life
Beaches are not just about the sand and the sea; they are also home to a diverse array of marine life. From colorful corals to vibrant fish, the underwater world is a sight to behold. Beaches are not just about the sand and the sea; they are also home to a diverse array of marine life. From colorful ((corals)) to vibrant fish, the underwater world is a sight to behold.
[quote, Marine Biologist, "The Beauty of Marine Life"] [quote, Marine Biologist, "The Beauty of Marine Life"]
____ ____
@ -44,7 +44,7 @@ image::forest.jpg[Forest, width=600, align=center]
==== Biodiversity ==== Biodiversity
Forests are incredibly biodiverse. The Amazon Rainforest, for example, is home to over 400 billion individual trees representing more than 16,000 species. Forests are incredibly biodiverse. The ((Amazon)) Rainforest, for example, is home to over 400 billion individual trees representing more than 16,000 species.
* Fun Fact: The Amazon Rainforest produces 20% of the world's oxygen. * Fun Fact: The Amazon Rainforest produces 20% of the world's oxygen.

View File

@ -7,7 +7,7 @@ The ocean covers more than 70% of the Earth's surface and is home to a vast arra
[sidebar] [sidebar]
**** ****
Did you know? Did you know?
The Mariana Trench is the deepest part of the world's oceans, reaching a depth of about 36,000 feet. The ((Mariana Trench)) is the deepest part of the world's oceans, reaching a depth of about 36,000 feet.
**** ****
=== The Ocean Zones === The Ocean Zones
@ -45,7 +45,7 @@ Many deep-sea creatures have developed bioluminescence to survive in the dark en
==== The Giant Squid ==== The Giant Squid
The giant squid is a mysterious deep-sea creature that has fascinated scientists for centuries. The giant ((squid)) is a mysterious deep-sea creature that has fascinated scientists for centuries.
image::giant_squid.jpg[Giant Squid, width=500, align=center] image::giant_squid.jpg[Giant Squid, width=500, align=center]
@ -69,7 +69,7 @@ image::coral_reef.jpg[Coral Reef, width=500, align=center]
* Provide protection for coastlines * Provide protection for coastlines
* Support commercial and recreational fisheries * Support commercial and recreational fisheries
footnote:[Coral reefs cover less than 1% of the ocean floor but support 25% of all marine life.] footnote:[((Coral)) reefs cover less than 1% of the ocean floor but support 25% of all marine life.]
=== The Impact of Human Activity === The Impact of Human Activity
@ -93,7 +93,7 @@ image::plastic_pollution.jpg[Plastic Pollution, width=500, align=center]
==== Overfishing ==== Overfishing
Overfishing has led to the depletion of many fish species, disrupting marine ecosystems and food chains. ((Overfishing)) has led to the depletion of many fish species, disrupting marine ecosystems and food chains.
. Solutions to Overfishing . Solutions to Overfishing
* Implementing catch limits * Implementing catch limits

View File

@ -6,7 +6,7 @@ Ecosystems are complex networks of organisms and their environment. This chapter
=== Terrestrial Ecosystems === Terrestrial Ecosystems
Terrestrial ecosystems are found on land and include forests, grasslands, deserts, and tundras. ((Terrestrial)) ecosystems are found on land and include forests, grasslands, deserts, and tundras.
[plantuml, forest_diagram, png, width=600, align=center] [plantuml, forest_diagram, png, width=600, align=center]
---- ----
@ -42,7 +42,7 @@ image::forest_2.jpg[Forest, width=500, align=center]
=== Aquatic Ecosystems === Aquatic Ecosystems
Aquatic ecosystems are found in water environments and include freshwater and marine ecosystems. ((Aquatic)) ecosystems are found in water environments and include freshwater and marine ecosystems.
[plantuml, marine_ecosystem, png, width=600, align=center] [plantuml, marine_ecosystem, png, width=600, align=center]
---- ----
@ -64,7 +64,7 @@ package "Marine Ecosystem" {
==== Marine Ecosystem ==== Marine Ecosystem
Marine ecosystems are the largest of Earth's aquatic ecosystems and are distinguished by their high salt content. ((Marine ecosystems)) are the largest of Earth's aquatic ecosystems and are distinguished by their high salt content.
image::marine.jpg[Marine, width=500, align=center] image::marine.jpg[Marine, width=500, align=center]

View File

@ -6,7 +6,7 @@ Mathematics is the language of nature. From the intricate patterns of seashells
=== The Fibonacci Sequence === The Fibonacci Sequence
The Fibonacci sequence is a series of numbers where each number is the sum of the two preceding ones, usually starting with 0 and 1. This sequence appears in various natural phenomena. The ((Fibonacci)) sequence is a series of numbers where each number is the sum of the two preceding ones, usually starting with 0 and 1. This sequence appears in various natural phenomena.
[stem] [stem]
++++ ++++
@ -24,7 +24,7 @@ image::fibonacci_spiral.jpg[Fibonacci Spiral, width=500, align=center]
=== The Golden Ratio === The Golden Ratio
The golden ratio, often denoted by the Greek letter φ (phi), is an irrational number approximately equal to 1.6180339887. It appears in various aspects of art, architecture, and nature. The golden ratio, often denoted by the ((Greek)) letter φ (phi), is an irrational number approximately equal to 1.6180339887. It appears in various aspects of art, architecture, and nature.
[stem] [stem]
++++ ++++
@ -33,7 +33,7 @@ The golden ratio, often denoted by the Greek letter φ (phi), is an irrational n
==== Golden Ratio in Nature ==== Golden Ratio in Nature
The golden ratio can be observed in the proportions of the human body, the arrangement of leaves, and the patterns of flower petals. The ((golden)) ratio can be observed in the proportions of the human body, the arrangement of leaves, and the patterns of flower petals.
image::golden_ratio.jpg[Golden Ratio, width=500, align=center] image::golden_ratio.jpg[Golden Ratio, width=500, align=center]
@ -77,7 +77,7 @@ image::fractal_broccoli.jpg[Fractal Broccoli, width=500, align=center]
=== Calculus in Nature === Calculus in Nature
Calculus, the mathematical study of continuous change, helps describe various natural phenomena, such as the motion of planets, the growth of populations, and the spread of diseases. ((Calculus)), the mathematical study of continuous change, helps describe various natural phenomena, such as the motion of planets, the growth of populations, and the spread of diseases.
==== Motion of Planets ==== Motion of Planets

View File

@ -2,11 +2,11 @@
=== Introduction === Introduction
Fractals are complex patterns that are self-similar across different scales. They are fascinating both in their mathematical properties and their visual appeal. In this chapter, we will explore how to program fractals using Elixir and Go, focusing on some of the most famous fractal patterns such as the Mandelbrot set and the Sierpinski triangle. ((Fractals)) are complex patterns that are self-similar across different scales. They are fascinating both in their mathematical properties and their visual appeal. In this chapter, we will explore how to program fractals using Elixir and Go, focusing on some of the most famous fractal patterns such as the Mandelbrot set and the Sierpinski triangle.
=== The Mandelbrot Set === The Mandelbrot Set
The Mandelbrot set is a set of complex numbers that produces a distinctive and famous fractal shape. The set is defined by iterating the function: The ((Mandelbrot)) set is a set of complex numbers that produces a distinctive and famous fractal shape. The set is defined by iterating the function:
[stem] [stem]
++++ ++++
@ -15,7 +15,7 @@ z_{n+1} = z_n^2 + c
==== Plotting the Mandelbrot Set in Elixir ==== Plotting the Mandelbrot Set in Elixir
Let's start with a basic Elixir program to plot the Mandelbrot set. Let's start with a basic ((Elixir)) program to plot the Mandelbrot set.
[source,elixir] [source,elixir]
---- ----
@ -46,7 +46,7 @@ plot = Mandelbrot.mandelbrot_set(-2.0, 1.0, -1.5, 1.5, 800, 800, 256)
==== Plotting the Mandelbrot Set in Go ==== Plotting the Mandelbrot Set in Go
Here's a Go program to plot the Mandelbrot set. Here's a ((Go)) program to plot the Mandelbrot set.
[source,go] [source,go]
---- ----