Skip to content

Commit 1a2ed38

Browse files
committed
Make main page look slimmer
1 parent 0671fd3 commit 1a2ed38

3 files changed

Lines changed: 41 additions & 17 deletions

File tree

src/_layouts/default.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,19 @@
1616
<h1 class="project-name">{{ site.title | default: site.github.repository_name }}</h1>
1717
<h2 class="project-tagline">{{ site.description | default: site.github.project_tagline }}</h2>
1818
{% if site.show_downloads %}
19+
<!--
20+
Commented out: make header look slimmer.
1921
<b>Stable version ({{ site.pasdoc.stable_download_version }}):</b>
2022
<br>
23+
-->
24+
2125
<a href="https://github.com/pasdoc/pasdoc/releases/download/v{{ site.pasdoc.stable_download_version }}/pasdoc-{{ site.pasdoc.stable_download_version }}-win64.zip" class="btn">Windows (x86_64)</a>
2226
<a href="https://github.com/pasdoc/pasdoc/releases/download/v{{ site.pasdoc.stable_download_version }}/pasdoc-{{ site.pasdoc.stable_download_version }}-linux-x86_64.tar.gz" class="btn">Linux (x86_64)</a>
2327
<a href="https://github.com/pasdoc/pasdoc/releases/download/v{{ site.pasdoc.stable_download_version }}/pasdoc-{{ site.pasdoc.stable_download_version }}-linux-arm.tar.gz" class="btn">Linux (Arm, 32-bit) (Raspberry Pi)</a>
2428
<a href="https://github.com/pasdoc/pasdoc/releases/download/v{{ site.pasdoc.stable_download_version }}/pasdoc-{{ site.pasdoc.stable_download_version }}-darwin-x86_64.zip" class="btn">macOS (x86_64)</a>
2529

30+
<!--
31+
Commented out: make header look slimmer.
2632
<br>
2733
<br>
2834
@@ -34,12 +40,16 @@ <h2 class="project-tagline">{{ site.description | default: site.github.project_t
3440
<a href="https://github.com/pasdoc/pasdoc/releases/download/snapshot/pasdoc-{{ site.pasdoc.unstable_download_version }}-linux-aarch64.tar.gz" class="btn">Linux (Aarch64, 64-bit) (Raspberry Pi, PineTab2)</a>
3541
<a href="https://github.com/pasdoc/pasdoc/releases/download/snapshot/pasdoc-{{ site.pasdoc.unstable_download_version }}-darwin-x86_64.zip" class="btn">macOS (x86_64)</a>
3642
<a href="https://github.com/pasdoc/pasdoc/releases/download/snapshot/pasdoc-{{ site.pasdoc.unstable_download_version }}-darwin-x86_64.zip" class="btn">macOS (Aarch64)</a>
43+
-->
3744
{% endif %}
3845
{% if site.github.is_project_page %}
46+
<!--
47+
Commented out: make header look slimmer.
3948
<br>
4049
<br>
4150
4251
<a href="{{ site.pasdoc.repository_url }}" class="btn">Source code (build with FPC or Delphi)</a>
52+
-->
4353
{% endif %}
4454
</section>
4555
{% endif %}

src/_sass/pasdoc.scss

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,17 @@
100100
/* background: #B2D2E1 !important; */
101101
background: #475a94 !important;
102102
/* background: #4e4b42 !important; */
103+
104+
h2 {
105+
/* smaller margin than theme default, to be closer to "PasDoc" header */
106+
margin-top: 0.1rem;
107+
}
108+
109+
a.btn {
110+
/* margin on right, not left, to make 2nd line of buttons aligned with 1st */
111+
margin-left: 0;
112+
margin-right: 0.5rem;
113+
}
103114
}
104115

105116
/* Make sure <pre> is not too wide, like on ListTags page with wide <pre> element */

src/index.asciidoc

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,19 @@ and / or in dedicated "description files". Numerous output formats are supported
1313

1414
This is a _free and open source software_.
1515
//PasDoc itself is written using modern Object Pascal and can be build using FPC or Delphi.
16-
We https://castle-engine.io/donate[appreciate your donations (Michalis, maintainer of PasDoc, also makes Castle Game Engine)], esp. if you use PasDoc in a commercial project. This helps us to continue developing and improving PasDoc.
17-
18-
## Download
19-
20-
Download:
21-
22-
* Latest *stable* PasDoc release https://github.com/pasdoc/pasdoc/releases/latest[can be downloaded from here].
2316

24-
* Latest *unstable* (automatic build after every commit, published once automatic tests pass) release https://github.com/pasdoc/pasdoc/releases/tag/snapshot[is available here ("snapshot" releases)].
25-
26-
You can watch our https://github.com/pasdoc/pasdoc/releases[releases page] or https://github.com/pasdoc/pasdoc/discussions/categories/announcements[announcements category in our discussions] to be notified about a new release.
17+
We https://castle-engine.io/donate[appreciate your donations (Michalis, maintainer of PasDoc, also makes Castle Game Engine)], esp. if you use PasDoc in a commercial project. This helps us to continue developing and improving PasDoc.
2718

28-
## Tutorial
19+
## Basic Usage
2920

3021
Put comments before the identifiers in your Pascal source code. Like this:
3122

3223
```pascal
3324
{ My amazing unit. }
3425
unit MyUnit;
26+
3527
interface
28+
3629
type
3730
{ My amazing class. }
3831
TMyClass = class
@@ -42,6 +35,7 @@ type
4235
{ My amazing property. }
4336
property MyProperty: string read GetMyProperty;
4437
end;
38+
4539
implementation
4640
...
4741
end.
@@ -58,20 +52,20 @@ You can also use the GUI interface, see link:PasDocGui[PasDoc GUI].
5852

5953
## Examples
6054

61-
- This is https://pasdoc.github.io/autodoc/html/index.html[PasDoc's own documentation in the HTML format].
55+
- Take a look at https://pasdoc.github.io/autodoc/html/index.html[PasDoc's own documentation (in the HTML format)].
6256
63-
- See also link:PasDocAutoDoc[PasDoc's own documentation in all the formats] .
57+
- See link:PasDocAutoDoc[PasDoc's own documentation in all the formats].
6458
6559
- See link:ProjectsUsingPasDoc[Projects using PasDoc] for links to larger real-world
6660
examples of how documentation generated by PasDoc looks like.
6761
68-
## More usage information: output formats, command-line options, examples
62+
## Features
6963

7064
For more information on how to document your source code see:
7165

7266
- link:WhereToPlaceComments[Where To Place Comments]
7367
- link:WritingDocumentation[Writing Documentation]
74-
- link:SupportedTags[Supported Tags].
68+
- link:SupportedTags[Supported Tags]
7569
7670
Available output formats:
7771

@@ -85,8 +79,17 @@ Available output formats:
8579
Check out the link:CommandLine[CommandLine] to get a better feeling
8680
for how PasDoc works.
8781

88-
You may also be interested in the list of
89-
link:AdvancedFeatures[AdvancedFeatures] of PasDoc.
82+
See also the list of link:AdvancedFeatures[AdvancedFeatures] of PasDoc.
83+
84+
## All Downloads (Stable and Unstable)
85+
86+
Download:
87+
88+
* Latest *stable* PasDoc release https://github.com/pasdoc/pasdoc/releases/latest[can be downloaded from here].
89+
90+
* Latest *unstable* (automatic build after every commit, published once automatic tests pass) release https://github.com/pasdoc/pasdoc/releases/tag/snapshot[is available here ("snapshot" releases)].
91+
92+
You can watch our https://github.com/pasdoc/pasdoc/releases[releases page] or https://github.com/pasdoc/pasdoc/discussions/categories/announcements[announcements category in our discussions] to be notified about a new release.
9093

9194
## Get involved
9295

0 commit comments

Comments
 (0)