gorltom/README.md

91 lines
2.5 KiB
Markdown

# gorltom
golang url to mark-down API
gorltom is a simple to use API that takes in a full url
https://gorltom.corbia.net/api/url
And returns a markdown file with the following format:
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title of the example webpage</title>
</head>
<body>
<div class="bloat that is only usefull for browsers">
<div class="some-ugly-class">
<nav id="top-menu">
<ul class="nostyle ul bs">
<li class="random bs 342345234fffDDD">
<span class="menu item obviously">
<a href="/about" target="_blank">ABOUT</a>
</span>
</li>
<li class="random bs 342345234fffDDD">
<span class="menu item obviously">
<a href="/blog" target="_blank">BLOG</a>
</span>
</li>
</ul>
</nav>
</div>
<aside>
...
</aside>
<div>
<section class="main">
<article>
<header class="article-header-top-max">
<h3>Title of the article</h3>
</header>
<p>Text of the first paragraph of the article.</p><br>
<p>Text of the second paragraph of the article.</p><br>
<p>Text of the third paragraph of the article but this time it contains a <a href="https://link-to-another-website.com/example">link</a> inside of the text.</p><br>
</article>
</section>
</div>
</div>
</body>
</html>
```
```md
# Title of the example webpage
# (*gorltom extract of https://notexample.com/*)
# *assumed_menu*
- [ABOUT](https://notexample.com/about)
- [BLOG](https://notexample.com/blog)
# *article*
### Title of the article
Text of the first paragraph of the article.
Text of the second paragraph of the article
Text of the third paragraph of the article but this time it contains a [link]("https://link-to-another-website.com/example") inside of the text.
```
# Title of the example webpage
# (*gorltom extract of https://notexample.com/*)
# *assumed_menu*
- [ABOUT](https://notexample.com/about)
- [BLOG](https://notexample.com/blog)
# *article*
### Title of the article
Text of the first paragraph of the article.
Text of the second paragraph of the article
Text of the third paragraph of the article but this time it contains a [link]("https://link-to-another-website.com/example") inside of the text.