wiki.ohea.xyz/gollum
10
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

clarify deletion docs

Browse Source
This commit is contained in:
Tom Preston-Werner
2010-04-16 12:52:26 -04:00
parent 2b701ec675
commit f4fea23a7e
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -280,12 +280,16 @@ Get a specific version of a given static file:
gollum.file('asset.js', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a') gollum.file('asset.js', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
Write a new version of a page (the file will be created if it does not already Methods that write to the repository require a Hash of commit data that takes
exist) and commit the change. The file will be written at the repo root. the following form:
commit = { :message => 'commit message', commit = { :message => 'commit message',
:name => 'Tom Preston-Werner', :name => 'Tom Preston-Werner',
:email => 'tom@github.com' } :email => 'tom@github.com' }
Write a new version of a page (the file will be created if it does not already
exist) and commit the change. The file will be written at the repo root.
gollum.write_page('Page Name', :markdown, 'Page contents', commit) gollum.write_page('Page Name', :markdown, 'Page contents', commit)
Update an existing page (keeps the same name, format, and directory location). Update an existing page (keeps the same name, format, and directory location).
@@ -294,8 +298,4 @@ Update an existing page (keeps the same name, format, and directory location).
To delete a page and commit the change: To delete a page and commit the change:
gollum.delete_page('Page Name') gollum.delete_page('Page Name', commit)
Once again, you can optionally specify a commit message:
gollum.delete_page('Page Name', 'commit message')