htmlc 1.0.38

.NET 6.0
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global htmlc --version 1.0.38
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local htmlc --version 1.0.38
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=htmlc&version=1.0.38
nuke :add-package htmlc --version 1.0.38

html-compiler-tool

html-compiler-tool

.NET Version License Build Downloads NuGet

Lines of Code Vulnerabilities

buy me a coffe

This is the HTML Compiler Tool for your cli

installation and update

first: install the .NET Runtime

you need to install the .NET Runtime (its free and available for macos, linux and windows)

then: install the tool

then you can install the html-tool very simple via this command:

dotnet tool install --global htmlc

update the tool

dotnet tool update --global htmlc

usage

The compile process searches in the folder for all HTML files. All files that do NOT start with an underscore are compiled. Files with an underscore (for example _layout.html or _footer.html) are used as reusable components.

html files

different html types

entry html

The compiler searches for all HTML files which do NOT start with an underscore (index.html, a-page.html, etc.). files like _layout.html, footer.html, etc. are ignored.

for example:

/src/index.html<br /> /src/pages.html<br /> /src/components/buttons.html<br />

layout

The layout file must start with an underscore. The rest of the naming is up to you. the content consists of reusable layout in HTML (styles and scripts, header, navigation, etc.).

for example:

/src/_layout.html<br />

reusable components

In addition, you can use other recyclable components. The file name must start with an underscore. The rest of the naming is up to you.

for example:

/src/_navigation.html<br /> /src/_header.html<br /> /src/_footer.html<br />

supported tags and its functionality

@Layout

The @Layout tag is used in an HTML entry file to specify which layout file is to use.

@Body

The @Body tag determines in a layout file where the content from the actual HTML entry file is written.

@File

You can include another file with the @File tag in any HTML file (whether layout file. reusable file or entry file).

@StylePath

htmlc can also compile style files (scss or sass). the path of the compiled CSS file can be inserted using this @StylePath tag. The following usage makes sense:<br /> <link rel="stylesheet" href="@StylePath"><br />

getting started with your own project

  1. create a directory with two subdirectories /src and /dist. All project files must be stored under /src. The compiler writes the results under /dist.
  2. create an initial entry file index.html.
  3. create a layout file _layout.html.
  4. write the following basic HTML structure in the _layout.html file.<br /> <html><br /> <head><br /> </head><br /> <body><br /> @Body<br /> </body><br /> </html><br />
  5. write the following example in index.html.<br /> @Layout=_layout.html<br /> <section><br /> <div>Hello again</div><br /> </section><br />
  6. open the console of your choice and change to the project directory. (/src and /dist must be in it).
  7. type the following command:<br /> htmlc compile<br />
  8. under /dist should now appear a file index.html with the following content:<br /> <html><br /> <head><br /> </head><br /> <body><br /> <section><br /> <div>Hello again</div><br /> </section><br /> </body><br /> </html><br />

commands

compile

This command compiles all HTML files from the /src (rekusriv) folder and writes the results to /dist.

htmlc compile <project-directory>

If only one path is specified, htmlc searches for /src and /dist in this directory. If these do not exist, then they are created. Then htmlc searches for files in /src and writes the results to the /dist directory. If no path is specified, then htmlc searches for /src and /dist in the current folder.

project-directory (optional): the path to the project directory. for example: /path/to/project

htmlc compile <source-directory> <output-directory>

If two folders are specified, then htmlc uses the first value as the source path and the second value as the output paths.

source-directory (optional): The path to the source directory (equivalent to /src). for example: /path/to/project/src

output-directory (optional): The path to the output directory (equivalent to /dist). for example: /path/to/another/directory/output

htmlc compile [...] [-s --style {path/to/main.scss}]

Optionally, a relative path to the style entry file can be specified with -s or -style. the path to the style file must be specified relative to the /src directory. the relative path to the final css-file is written to the @StylePath-tags.

watch

This command compiles all HTML files from the /src (rekusriv) folder and writes the results to /dist. then /src is observed for changes and recompiled whenever a change is made.

htmlc watch <project-directory>

The watch command is identical to the compile command. The only difference is that the watch command observes the directory after the first compile and restarts the compile process every time a change is made.

project-directory (optional): the path to the project directory. for example: /path/to/project

htmlc watch <source-directory> <output-directory>

If two folders are specified, then htmlc uses the first value as the source path and the second value as the output paths.

source-directory (optional): The path to the source directory (equivalent to /src). for example: /path/to/project/src

output-directory (optional): The path to the output directory (equivalent to /dist). for example: /path/to/another/directory/output

htmlc watch [...] [-s --style {/path/to/main.scss}]

Optionally, a relative path to the style entry file can be specified with -s or -style. the path to the style file must be specified relative to the /src directory. the relative path to the final css-file is written to the @StylePath-tags.

notices

this tool uses:

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.156 543 12/3/2023
1.0.155 200 11/8/2023
1.0.154 316 11/6/2023
1.0.153 251 11/6/2023
1.0.149 220 10/10/2023
1.0.148 181 10/9/2023
1.0.147 148 10/6/2023
1.0.146 147 10/6/2023
1.0.145 174 10/4/2023
1.0.144 231 9/28/2023
1.0.143 182 9/28/2023
1.0.142 180 9/27/2023
1.0.141 262 9/27/2023
1.0.140 165 9/27/2023
1.0.139 189 9/24/2023
1.0.137 178 9/23/2023
1.0.136 225 9/19/2023
1.0.135 159 9/19/2023
1.0.133 200 9/19/2023
1.0.132 252 9/19/2023
1.0.131 153 9/19/2023
1.0.128 226 9/17/2023
1.0.124 160 9/7/2023
1.0.121 228 9/6/2023
1.0.117 192 8/27/2023
1.0.115 615 8/11/2023
1.0.114 563 8/2/2023
1.0.112 422 7/29/2023
1.0.109 453 7/26/2023
1.0.107 403 7/26/2023
1.0.106 418 7/24/2023
1.0.72 742 2/17/2023
1.0.70 578 2/17/2023
1.0.69 722 2/17/2023
1.0.68 660 2/17/2023
1.0.66 670 2/17/2023
1.0.64 626 2/10/2023
1.0.63 718 1/23/2023
1.0.62 818 1/23/2023
1.0.61 802 1/23/2023
1.0.60 825 1/23/2023
1.0.59 675 1/23/2023
1.0.58 685 1/21/2023
1.0.57 718 1/21/2023
1.0.56 778 1/21/2023
1.0.55 634 1/21/2023
1.0.54 722 1/21/2023
1.0.53 621 1/21/2023
1.0.52 692 1/21/2023
1.0.51 778 1/6/2023
1.0.50 666 1/6/2023
1.0.49 811 1/5/2023
1.0.48 758 1/5/2023
1.0.47 799 1/5/2023
1.0.46 848 1/5/2023
1.0.45 808 1/5/2023
1.0.44 878 1/5/2023
1.0.43 887 1/4/2023
1.0.42 784 1/4/2023
1.0.41 875 1/4/2023
1.0.40 808 1/4/2023
1.0.39 829 1/4/2023
1.0.38 857 1/4/2023
1.0.37 790 1/4/2023
1.0.36 779 1/4/2023
1.0.35 772 1/3/2023
1.0.34 842 1/3/2023
1.0.33 873 1/3/2023
1.0.32 845 1/3/2023
1.0.31 744 1/2/2023
1.0.30 741 1/2/2023
1.0.29 739 1/2/2023
1.0.28 800 1/2/2023
1.0.27 849 1/1/2023
1.0.26 810 1/1/2023
1.0.25 763 1/1/2023
1.0.24 766 1/1/2023
1.0.23 701 1/1/2023
1.0.22 756 1/1/2023
1.0.21 702 1/1/2023
1.0.20 717 1/1/2023
1.0.19 318 12/31/2022
1.0.18 302 12/31/2022
1.0.17 321 12/31/2022
1.0.16 318 12/31/2022
1.0.15 294 12/29/2022
1.0.14 290 12/28/2022
1.0.13 311 12/28/2022
1.0.12 319 12/20/2022
1.0.11 392 11/4/2022
1.0.10 387 11/1/2022
1.0.9 370 11/1/2022
1.0.8 401 10/31/2022
1.0.6 387 8/21/2022
1.0.4 384 8/18/2022
1.0.3 393 8/17/2022
1.0.2 393 8/17/2022
1.0.0 389 8/17/2022