Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: bit misspell comments README #3

Merged
merged 2 commits into from
Sep 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ Jektex supports both the built-in Kramdown math notation, and the newer LaTeX-on

### Kramdown notation
**Inline formula**
Put formula between two pairs of dolar signs (`$$`) inside of paragraph.
Put formula between two pairs of dollar signs (`$$`) inside of paragraph.
```latex
Lorem ipsum dolor sit amet, consectetur $$e^{i\theta}=\cos(\theta)+i\sin(\theta)$$
adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
```

**Display formula**
Put formula between two pairs of dolar sings (`$$`) and surround it with two empty lines.
Put formula between two pairs of dollar signs (`$$`) and surround it with two empty lines.
```latex
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
Expand Down
6 changes: 3 additions & 3 deletions lib/jektex/jektex.rb
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def escape_method(type, expression, doc_path)

# use it if it exists
if($cache.has_key?(expression_hash) && !contains_updated_global_macro?(expression))
# check if expressin conains updated macro
# check if expression contains updated macro
$count_newly_generated_expressions += 1
print_stats unless $silent
return $cache[expression_hash]
Expand Down Expand Up @@ -166,7 +166,7 @@ def escape_method(type, expression, doc_path)
end
end

# check is silent mode is activated
# check if silent mode is activated
$silent = config["silent"] if config.has_key?("silent")
# make list of updated macros
$updated_global_macros = get_list_of_updated_global_macros($global_macros, $cache["cached_global_macros"])
Expand Down Expand Up @@ -197,7 +197,7 @@ def escape_method(type, expression, doc_path)
end

Jekyll::Hooks.register :site, :post_write do
# print stats once more to prevent them from being overwriten by error log
# print stats once more to prevent them from being overwritten by error log
print_stats unless $silent
# print new line to prevent overwriting previous output
print "\n" unless $silent
Expand Down