Categorygithub.com/Darcoprogramador/go-notemarkdown
modulepackage
0.0.0-20240930022840-b3779b884ce0
Repository: https://github.com/darcoprogramador/go-notemarkdown.git
Documentation: pkg.go.dev

# README

Go NoteMarkdown

Go NoteMarkdown es una aplicación web para subir archivos Markdown y renderizarlos en HTML con resaltado de sintaxis.

Requisitos

  • Go 1.22.2 o superior

Instalación

  1. Clona el repositorio:

    git clone https://github.com/Darcoprogramador/go-notemarkdown.git
    cd go-notemarkdown
    
  2. Instala las dependencias:

    go mod download
    

Uso

  1. Ejecuta la aplicación:

    go run main.go
    
  2. Abre tu navegador y navega a http://localhost:8000.

Estructura del Proyecto

go-notemarkdown/
├── go.mod
├── go.sum
├── handlers/
│   └── handlers.go
├── main.go
├── routes/
│   └── routes.go
├── storage/
│   └── storage.go
│   └── temp/
├── utils/
│   ├── markdown.go
│   └── markdown_test.go
└── views/
    └── index.html

Endpoints

  • Get /api/notes : Ve el listado de notas existente
  • Post /api/notes : Sube un archivo Markdown
  • Get /api/notes/:filename : Renderiza la nota a un html
  • Get /api/notes/:filename/check : Checa la gramatica de la nota consultando a una API externa (Aun no implementado)

Ejemplo de Uso

Subir un archivo Markdown

curl -F "file=@path/to/your/file.md" http://localhost:8000/api/notes

Renderizar un Archivo MD Después de subir el archivo, puedes renderizarlo navegando a:

http://localhost:8000/api/notes/filename.md

Reto de roadmap.sh

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author