Skip to content

Commit ee23c9a

Browse files
authored
Merge pull request #6 from pgEdge/online_docs
Updates to documentation for LICENSE file location; nav tree updates
2 parents 583ea29 + faf9506 commit ee23c9a

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,17 @@
2323
- [Troubleshooting](docs/troubleshooting.md)
2424
- [Licence](docs/LICENCE.md)
2525

26-
pgEdge Document Loader is a command-line tool for loading documents from various formats into PostgreSQL databases. Full documentation is available at:
27-
28-
[https://pgedge.github.io/pgedge-docloader](https://pgedge.github.io/pgedge-docloader)
26+
pgEdge Document Loader is a command-line tool for loading documents from various formats into PostgreSQL databases. Full documentation is available [here](https://docs.pgedge.com/pgedge-docloader/).
2927

3028
The pgEdge Document Loader automatically converts documents (HTML, Markdown, reStructuredText, and SGML/DocBook) to Markdown format and loads them into a PostgreSQL database with extracted metadata.
3129

3230
**Features**
3331

34-
- **Multiple Format Support**: HTML, Markdown, reStructuredText, and SGML/DocBook
32+
The pgEdge Document Loader automatically converts documents (HTML, Markdown, reStructuredText, and DocBook SGML/XML) to Markdown format and loads them into a PostgreSQL database with extracted metadata.
33+
34+
**Features**
35+
36+
- **Multiple Format Support**: HTML, Markdown, reStructuredText, and DocBook SGML/XML
3537
- **Automatic Conversion**: All formats converted to Markdown
3638
- **Metadata Extraction**: Titles, filenames, timestamps
3739
- **Flexible Input**: Single file, directory, or glob patterns (including `**` recursive matching)
@@ -46,8 +48,8 @@ The pgEdge Document Loader automatically converts documents (HTML, Markdown, reS
4648

4749
Before installing and using pgEdge Document Loader, download and install:
4850

49-
- Go 1.21 or later
50-
- PostgreSQL 12 or later
51+
- Go 1.23 or later
52+
- PostgreSQL 14 or later
5153

5254
Getting started with pgEdge Document Loader involves three steps:
5355

@@ -145,10 +147,9 @@ Your contributions are welcome! Please feel free to submit issues and pull reque
145147

146148
## Support
147149

148-
- Documentation: [https://pgedge.github.io/pgedge-docloader](https://pgedge.github.io/pgedge-docloader)
150+
- Documentation: [pgEdge Docloader](https://docs.pgedge.com/pgedge-docloader/)
149151
- Issues: [GitHub Issues](https://github.com/pgedge/pgedge-docloader/issues)
150152

151153
## License
152154

153-
This project is licensed under the PostgreSQL License. See
154-
[LICENCE.md](LICENCE.md) for details.
155+
This project is licensed under the [PostgreSQL License](LICENCE.md).

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ before storing them in the database.
77

88
pgEdge Document Loader supports the following document formats:
99

10-
- **HTML** (`.html`, `.htm`) - Extracts the document title from `<title>` tag
11-
- **Markdown** (`.md`) - Extracts the title from first `#` heading
12-
- **reStructuredText** (`.rst`) - Extracts the title from underlined headings
10+
- **HTML** (`.html`, `.htm`) - Extracts the document title from `<title>` tags.
11+
- **Markdown** (`.md`) - Extracts the title from first `#` headings.
12+
- **reStructuredText** (`.rst`) - Extracts the title from underlined headings.
13+
- **DocBook SGML/XML** (`.sqml`, `.xml` ) - Extracts the title from `<title>` or `<refentrytitle>` tags (PostgreSQL-style reference pages use `<refentrytitle>`).
1314

1415
**Key Features**
1516

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ copyright: Copyright &copy; 2025 pgEdge, Inc
5050
repo_url: https://github.com/pgEdge/pgedge-docloader
5151

5252
nav:
53-
- Introduction:
53+
- pgEdge Document Loader:
5454
- Introduction: index.md
5555
- Best Practices: best_practices.md
5656
- Installing pgEdge Document Loader:

0 commit comments

Comments
 (0)