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

Update Readme #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme #26

wants to merge 1 commit into from

Conversation

duianto
Copy link

@duianto duianto commented Jul 22, 2019

Overview section:

  • Remove the empty last table row

Features section:

  • Removed duplicate M-x.
  • Moved both the key binding and command to the second line.
    Github still shows the comment and key binding/command on a
    single line, but it's easier to read in the readme.org file,
    when M-x is on the same line as the command.

Demos section:

  • Added verbatim emphasis (equal signs) around M-x commands.

Screenshots section:

  • Update renamed command (dash to slash):
    =M-x org-wiki-search-pattern= -> =M-x org-wiki/search-pattern=
  • Missing s after page
  1. =M-x org-wiki-search-pattern= Search for all wiki page that contains
    a pattern. (string or regex pattern).
  • Missing t in patern in: `=M-x org-wiki/search-patern - System.Windows=

Workflow section:

  • Added verbatim emphasis around M-x commands and a key binding.

Configuration section:

  • Added verbatim emphasis around the single and double backslashes
    (double backslashes were not visible on github).

Open org-wiki pages in read-only section:

  • Added verbatim emphasis around a key binding.

Start the wiki section:

  • Added verbatim emphasis around M-x command.

Command Summary section:

  • Reduced double empty table rows to a single row between the sections:
    • Navigation and Close Command
    • Alias Command and Backup Command
  • And removed the two empty table rows at the end of the Misc section.

M-x org-wiki-insert-link section:

  • Added verbatim emphasis around M-x command.

M-x org-wiki-header section:

  • Added missing closing verbatim emphasis sign.

M-x org-wiki-asset-create section:

  • Changed (backticks/grave accent characters) around commands to verbatim emphasis.

M-x org-wiki-asset-download-insert1 section:

  • Added verbatim emphasis around M-x command and a key binding.
  • Fixed typo: happesn -> happens

M-x org-wiki-asset-download-insert2 section:

  • Added verbatim emphasis around M-x command.
  • Changed the command ending in a 1 to end in a 2:
    M-x org-wiki-asset-download-insert1 -> M-x org-wiki-asset-download-insert2
    Since it's in the org-wiki-asset-download-insert2 section the command probably
    should use the command ending in a 2.

Modify it section:

  • Added verbatim emphasis around M-x commands.

Overview section:
- Remove the empty last table row

Features section:
- Removed duplicate M-x.
- Moved both the key binding and command to the second line.
Github still shows the comment and key binding/command on a
single line, but it's easier to read in the readme.org file,
when M-x is on the same line as the command.

Demos section:
- Added verbatim emphasis (equal signs) around M-x commands.

Screenshots section:
- Update renamed command (dash to slash):
=M-x org-wiki-search-pattern= -> =M-x org-wiki/search-pattern=
- Missing `s` after `page`
6. =M-x org-wiki-search-pattern= Search for all wiki page that contains
   a pattern. (string or regex pattern).
- Missing `t` in `patern` in: `=M-x org-wiki/search-patern - System.Windows=

Workflow section:
- Added verbatim emphasis around M-x commands and a key binding.

Configuration section:
- Added verbatim emphasis around the single and double backslashes
(double backslashes were not visible on github).

Open org-wiki pages in read-only section:
- Added verbatim emphasis around a key binding.

Start the wiki section:
- Added verbatim emphasis around M-x command.

Command Summary section:
- Reduced double empty table rows to a single row between the sections:
  - Navigation and Close Command
  - Alias Command and Backup Command
- And removed the two empty table rows at the end of the Misc section.

M-x org-wiki-insert-link section:
- Added verbatim emphasis around M-x command.

M-x org-wiki-header section:
- Added missing closing verbatim emphasis sign.

M-x org-wiki-asset-create section:
- Changed (backticks/grave accent characters) around commands to verbatim emphasis.

M-x org-wiki-asset-download-insert1 section:
- Added verbatim emphasis around M-x command and a key binding.
- Fixed typo: happesn -> happens

M-x org-wiki-asset-download-insert2 section:
- Added verbatim emphasis around M-x command.
- Changed the command ending in a 1 to end in a 2:
M-x org-wiki-asset-download-insert1 -> M-x org-wiki-asset-download-insert2
Since it's in the org-wiki-asset-download-insert2 section the command probably
should use the command ending in a `2`.

Modify it section:
- Added verbatim emphasis around M-x commands.
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.

None yet

1 participant