joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Expand empty RPC generation script to add example section and fix format

Browse source
This commit is contained in:
thephez 2017-10-10 09:22:52 -04:00
parent 5011081fb5
commit eecf9f8a32
1 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
scripts/create_empty_rpc_md.sh
View file

@ -8,19 +8,40 @@ PARAMCOUNT=$#
if [ "$PARAMCOUNT" == 1 ]; then if [ "$PARAMCOUNT" == 1 ]; then
FILENAME=${1,,}.md FILENAME=${1,,}.md
RPCNAME=$1 RPCNAME=$1
echo "{% comment %}" >> $FILENAME echo "{% comment %}" >> $FILENAME
echo "This file is licensed under the MIT License (MIT) available on" >> $FILENAME echo "This file is licensed under the MIT License (MIT) available on" >> $FILENAME
echo "http://opensource.org/licenses/MIT." >> $FILENAME echo "http://opensource.org/licenses/MIT." >> $FILENAME
echo "{% endcomment %}" >> $FILENAME echo "{% endcomment %}" >> $FILENAME
echo '{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/'$FILENAME'" %}' >> $FILENAME echo '{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/'$FILENAME'" %}' >> $FILENAME
echo "" >> $FILENAME echo "" >> $FILENAME
echo "##### $RPCNAME" >> $FILENAME echo "##### $RPCNAME" >> $FILENAME
echo "{% include helpers/subhead-links.md %}" >> $FILENAME echo "{% include helpers/subhead-links.md %}" >> $FILENAME
echo "" >> $FILENAME echo "" >> $FILENAME
echo "{% assign summary_${RPCNAME,}=\"\""" %}" >> $FILENAME
echo "" >> $FILENAME
echo "{% autocrossref %}" >> $FILENAME echo "{% autocrossref %}" >> $FILENAME
echo "" >> $FILENAME echo "" >> $FILENAME
echo "{% assign summary_${RPCNAME,}="" %}" >> $FILENAME echo "The \`${RPCNAME,,}\` RPC {{summary_${RPCNAME,}}}" >> $FILENAME
echo "" >> $FILENAME echo "" >> $FILENAME
# Example
echo "{% highlight bash %}" >> $FILENAME
echo "dash-cli -testnet ${RPCNAME,,}" >> $FILENAME
echo "{% endhighlight %}" >> $FILENAME
echo "" >> $FILENAME
# Example results
echo "Result:" >> $FILENAME
echo "{% highlight json %}" >> $FILENAME
echo " *INSERT RESULTS HERE*" >> $FILENAME
echo "{% endhighlight %}" >> $FILENAME
echo "" >> $FILENAME
echo "*See also:*" >> $FILENAME
echo "" >> $FILENAME
echo "{% endautocrossref %}" >> $FILENAME echo "{% endautocrossref %}" >> $FILENAME
cat $FILENAME cat $FILENAME