;doc: manuals: hide NAME/SYNOPSIS/DESCRIPTION headings in web manuals
[ci skip]
This commit is contained in:
		
							parent
							
								
									a6ec6b40da
								
							
						
					
					
						commit
						444c4342ed
					
				
							
								
								
									
										2
									
								
								Shake.hs
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								Shake.hs
									
									
									
									
									
								
							| @ -351,7 +351,7 @@ main = do | |||||||
|         ,"" |         ,"" | ||||||
|         ] |         ] | ||||||
|       cmd Shell |       cmd Shell | ||||||
|         "m4 -P -DMAN -DWEB -I" dir commonm4 packagem4 src "|" |         "m4 -P -DWEB -I" dir commonm4 packagem4 src "|" | ||||||
|         pandoc fromsrcmd towebmd |         pandoc fromsrcmd towebmd | ||||||
|         "--lua-filter tools/pandoc-demote-headers.lua" |         "--lua-filter tools/pandoc-demote-headers.lua" | ||||||
|         ">>" out |         ">>" out | ||||||
|  | |||||||
| @ -5,14 +5,15 @@ | |||||||
| _web_({{ | _web_({{ | ||||||
| _docversionlinks_({{csv}}) | _docversionlinks_({{csv}}) | ||||||
| }}) | }}) | ||||||
| _man_({{ |  | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| CSV - how hledger reads CSV data, and the CSV rules file format | CSV - how hledger reads CSV data, and the CSV rules file format | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 |  | ||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
| hledger can read | hledger can read | ||||||
| @ -861,5 +862,3 @@ This is all part of the CSV reader, one of several readers hledger can | |||||||
| use to parse input files. When all files have been read successfully, | use to parse input files. When all files have been read successfully, | ||||||
| the transactions are passed as input to whichever hledger command the | the transactions are passed as input to whichever hledger command the | ||||||
| user specified. | user specified. | ||||||
| 
 |  | ||||||
| 
 |  | ||||||
|  | |||||||
| @ -5,14 +5,15 @@ | |||||||
| _web_({{ | _web_({{ | ||||||
| _docversionlinks_({{journal}}) | _docversionlinks_({{journal}}) | ||||||
| }}) | }}) | ||||||
| _man_({{ |  | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| Journal - hledger's default file format, representing a General Journal | Journal - hledger's default file format, representing a General Journal | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 |  | ||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
| hledger's usual data source is a plain text file containing journal entries in hledger journal format. | hledger's usual data source is a plain text file containing journal entries in hledger journal format. | ||||||
|  | |||||||
| @ -5,14 +5,15 @@ | |||||||
| _web_({{ | _web_({{ | ||||||
| _docversionlinks_({{timeclock}}) | _docversionlinks_({{timeclock}}) | ||||||
| }}) | }}) | ||||||
| _man_({{ |  | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| Timeclock - the time logging format of timeclock.el, as read by hledger | Timeclock - the time logging format of timeclock.el, as read by hledger | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 |  | ||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
| hledger can read timeclock files. | hledger can read timeclock files. | ||||||
|  | |||||||
| @ -5,14 +5,15 @@ | |||||||
| _web_({{ | _web_({{ | ||||||
| _docversionlinks_({{timedot}}) | _docversionlinks_({{timedot}}) | ||||||
| }}) | }}) | ||||||
| _man_({{ |  | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| Timedot - hledger's human-friendly time logging format | Timedot - hledger's human-friendly time logging format | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 |  | ||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
| Timedot is a plain text format for logging dated, categorised quantities (of time, usually), supported by hledger. | Timedot is a plain text format for logging dated, categorised quantities (of time, usually), supported by hledger. | ||||||
|  | |||||||
| @ -8,18 +8,22 @@ _docversionlinks_({{hledger-ui}}) | |||||||
| 
 | 
 | ||||||
| _man_({{ | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| hledger-ui - terminal interface for the hledger accounting tool | hledger-ui - terminal interface for the hledger accounting tool | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # SYNOPSIS | # SYNOPSIS | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| `hledger-ui [OPTIONS] [QUERYARGS]`\ | `hledger-ui [OPTIONS] [QUERYARGS]`\ | ||||||
| `hledger ui -- [OPTIONS] [QUERYARGS]` | `hledger ui -- [OPTIONS] [QUERYARGS]` | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| _hledgerdescription_ | _hledgerdescription_ | ||||||
| }}) |  | ||||||
| 
 | 
 | ||||||
| _web_({{ | _web_({{ | ||||||
| <style> | <style> | ||||||
| @ -296,7 +300,7 @@ when you press g to reload. Once you have fixed the problem, | |||||||
| press g again to reload and resume normal operation. | press g again to reload and resume normal operation. | ||||||
| (Or, you can press escape to cancel the reload attempt.) | (Or, you can press escape to cancel the reload attempt.) | ||||||
| 
 | 
 | ||||||
| _man_({{ | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| **COLUMNS** | **COLUMNS** | ||||||
| @ -331,6 +335,3 @@ until the program is restarted. | |||||||
| 
 | 
 | ||||||
| Also, if you are viewing files mounted from another machine, `--watch` | Also, if you are viewing files mounted from another machine, `--watch` | ||||||
| requires that both machine clocks are roughly in step. | requires that both machine clocks are roughly in step. | ||||||
| 
 |  | ||||||
| 
 |  | ||||||
| }}) |  | ||||||
|  | |||||||
| @ -8,18 +8,22 @@ _docversionlinks_({{hledger-web}}) | |||||||
| 
 | 
 | ||||||
| _man_({{ | _man_({{ | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| hledger-web - web interface for the hledger accounting tool | hledger-web - web interface for the hledger accounting tool | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # SYNOPSIS | # SYNOPSIS | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| `hledger-web [OPTIONS]`\ | `hledger-web [OPTIONS]`\ | ||||||
| `hledger web -- [OPTIONS]` | `hledger web -- [OPTIONS]` | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| _hledgerdescription_ | _hledgerdescription_ | ||||||
| }}) |  | ||||||
| 
 | 
 | ||||||
| _web_({{ | _web_({{ | ||||||
| <style> | <style> | ||||||
| @ -241,8 +245,6 @@ $ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' - | |||||||
| By default, both the server-side HTML UI and the JSON API are served. | By default, both the server-side HTML UI and the JSON API are served. | ||||||
| Running with `--serve-api` disables the former, useful if you only want to serve the API. | Running with `--serve-api` disables the former, useful if you only want to serve the API. | ||||||
| 
 | 
 | ||||||
| _man_({{ |  | ||||||
| 
 |  | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| _LEDGER_FILE_ | _LEDGER_FILE_ | ||||||
| @ -262,5 +264,3 @@ Query arguments and some hledger options are ignored. | |||||||
| Does not work in text-mode browsers. | Does not work in text-mode browsers. | ||||||
| 
 | 
 | ||||||
| Does not work well on small screens. | Does not work well on small screens. | ||||||
| 
 |  | ||||||
| }}) |  | ||||||
|  | |||||||
| @ -16,21 +16,24 @@ _docversionlinks_({{hledger}}) | |||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
| _man_({{ | _man_({{ | ||||||
| 
 |  | ||||||
| # NAME | # NAME | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| hledger - a command-line accounting tool | hledger - a command-line accounting tool | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # SYNOPSIS | # SYNOPSIS | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| `hledger [-f FILE] COMMAND [OPTIONS] [ARGS]`\ | `hledger [-f FILE] COMMAND [OPTIONS] [ARGS]`\ | ||||||
| `hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]`\ | `hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]`\ | ||||||
| `hledger` | `hledger` | ||||||
| 
 | 
 | ||||||
|  | _man_({{ | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
|  | }}) | ||||||
| 
 | 
 | ||||||
| _hledgerdescription_ | _hledgerdescription_ | ||||||
| }}) |  | ||||||
| 
 | 
 | ||||||
| This is hledger’s command-line interface (there are also terminal and web | This is hledger’s command-line interface (there are also terminal and web | ||||||
| interfaces). Its basic function is to read a plain text file describing | interfaces). Its basic function is to read a plain text file describing | ||||||
| @ -70,7 +73,6 @@ _include_(hledger_examples.m4.md) | |||||||
| _include_(hledger_options.m4.md) | _include_(hledger_options.m4.md) | ||||||
| _include_(hledger_queries.m4.md) | _include_(hledger_queries.m4.md) | ||||||
| _include_(hledger_commands.m4.md) | _include_(hledger_commands.m4.md) | ||||||
| _man_({{ |  | ||||||
| 
 | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| @ -103,5 +105,3 @@ Not all of Ledger's journal file syntax is supported. See [file format differenc | |||||||
| On large data files, hledger is slower and uses more memory than Ledger. | On large data files, hledger is slower and uses more memory than Ledger. | ||||||
| 
 | 
 | ||||||
| _include_(hledger_troubleshooting.m4.md) | _include_(hledger_troubleshooting.m4.md) | ||||||
| 
 |  | ||||||
| }}) |  | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user