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

Adding documentation for glossarist #90

Merged
merged 3 commits into from
Dec 1, 2023

Conversation

HassanAkbar
Copy link
Member

Adding documentation for glossarist gem

closes #81

README.adoc Outdated

Add this line to your application's Gemfile:

```ruby
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use AsciiDoc source syntax.

gem 'glossarist'
```

And then execute:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use AsciiDoc source block syntax. Indentation is only used in markdown.

README.adoc Outdated

Localized concept has the following fields

- id: An optional identifier for the term, to be used in cross-references.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a definition list with double colons.

@ronaldtse
Copy link
Member

Thank you @HassanAkbar !

@ronaldtse ronaldtse merged commit 9ca9da1 into main Dec 1, 2023
14 checks passed
@ronaldtse ronaldtse deleted the adding_documentation_for_glossarist branch December 1, 2023 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Glossarist gem is very difficult to use
2 participants