Skip to content

Commit

Permalink
Update lifecycle-identity.md (#488)
Browse files Browse the repository at this point in the history
* Update lifecycle-identity.md

Version is only for Runme, not cells.

* Overwrite default identity of none using --identity flag

---------

Co-authored-by: Sebastian Tiedtke <sebastiantiedtke@gmail.com>
  • Loading branch information
pastuxso and sourishkrout authored Oct 15, 2024
1 parent 8688058 commit 4b5486d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/configuration/lifecycle-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ With this feature, you can easily track changes, versions, and the complete hist
### Usage

The following metadata will be added to your Markdown file :
The following metadata will be added to your Markdown file:

`id`: The unique identifier that represents the specific instance of your document or cell.

`version`: The current version number on your document or cell is the version of Runme you are using.
`version`: The current version number on your document is the version of Runme you are using.

Here is a sample of what the lifecycle identity on your file looks like:

Expand All @@ -25,7 +25,7 @@ runme:
To manually add the lifecycle identity to your markdown file, use the following command:
```sh {"id":"01HYX1H6800B70SWHVG6MFMHFM"}
runme fmt --write
runme fmt --identity all --write
```

> Note: Each document or cell will have a unique identifier generated by Runme. Do not edit these to avoid conflicts.
Expand Down

0 comments on commit 4b5486d

Please sign in to comment.