https://wiki.blender.jp/index.php?action=history&feed=atom&title=Dev%3ADoc%2FTools%2FUser_Reference_Manual%2FEditor_Vim%2FInstantRSTDev:Doc/Tools/User Reference Manual/Editor Vim/InstantRST - 版の履歴2026-06-17T11:07:42Zこのウィキのこのページに関する変更履歴MediaWiki 1.31.0https://wiki.blender.jp/index.php?title=Dev:Doc/Tools/User_Reference_Manual/Editor_Vim/InstantRST&diff=148439&oldid=prevYamyam: 1版 をインポートしました2018-06-28T21:10:46Z<p>1版 をインポートしました</p>
<table class="diff diff-contentalign-left" data-mw="interface">
<tr class="diff-title" lang="ja">
<td colspan="1" style="background-color: #fff; color: #222; text-align: center;">← 古い版</td>
<td colspan="1" style="background-color: #fff; color: #222; text-align: center;">2018年6月28日 (木) 21:10時点における版</td>
</tr><tr><td colspan="2" class="diff-notice" lang="ja"><div class="mw-diff-empty">(相違点なし)</div>
</td></tr></table>Yamyamhttps://wiki.blender.jp/index.php?title=Dev:Doc/Tools/User_Reference_Manual/Editor_Vim/InstantRST&diff=148438&oldid=prevwiki>Dfelinto: Undo revision 252324 by Dfelinto (talk)2015-07-03T03:14:18Z<p>Undo revision 252324 by <a href="/%E7%89%B9%E5%88%A5:%E6%8A%95%E7%A8%BF%E8%A8%98%E9%8C%B2/Dfelinto" title="特別:投稿記録/Dfelinto">Dfelinto</a> (<a href="/index.php?title=%E5%88%A9%E7%94%A8%E8%80%85%E3%83%BB%E3%83%88%E3%83%BC%E3%82%AF:Dfelinto&action=edit&redlink=1" class="new" title="利用者・トーク:Dfelinto (存在しないページ)">talk</a>)</p>
<p><b>新規ページ</b></p><div>This is a short guide on how I've been editing the blender-manual with real-time feedback (WYSIWYG).<br />
<br />
This guide relies on vim and the '''Instant-rst''' system by [https://github.com/Rykka Rykka]<br />
<br />
==Installation==<br />
<br />
1. Go to the Documentation Page and follow the instructions on how to build it [[https://developer.blender.org/project/view/53/ link]]<br />
<br />
(for this guide I'm assuming the sources are in '''~/blender-manual''')<br />
<br />
2. Install '''InstantRst''': [[https://github.com/Rykka/InstantRst link]] (this is a plugin for vim)<br />
<br />
3. Install '''InstantRst Server''': [[https://github.com/dfelinto/instant-rst.py/tree/blender-manual-static-templates link]] (this is a patched python plugin)<br />
<br />
==Running the Server==<br />
<source lang="bash">instantRst -f ~/blender-manual/manual/render/workflows/bake.rst -i ~/blender-manual/manual/images</source><br />
<br />
==Editing the Manual==<br />
<source lang="bash">vim ~/blender-manual/manual/render/workflows/bake.rst</source><br />
<br />
This will open the file in vim, and now you can run the plugin<br />
<source lang="bash">:InstantRst</source><br />
<br />
Start editing and look at your browser being updated while you edit it.<br />
<br />
==Further Considerations==<br />
Some RST syntaxes are not supported by Instanst-Rst server (in particularly guilabel, which we use a lot). So it's good to build the docs as you would normally to make sure everything looks fine. In this case you could either do '''make''' to build everything, or '''make render''' to build only the parts relative to the rendering.<br />
<br />
==Advanced Notes==<br />
The patched '''instant-rst server''' has two new additions:<br />
<br />
* A new command-line parameter for the images folder<br />
* The static files and templates the Blender Manual requires<br />
<br />
In the future we will try to change this system so it can be merged back upstream.</div>wiki>Dfelinto