Function serve_doc

codewiki/src/fe/visualise_docs.py:140–181

Serve individual documentation files.

(filename: str)

@app.get("/{filename:path}", response_class=HTMLResponse)
async def serve_doc(filename: str):
    """Serve individual documentation files."""
    initialize_globals()
    
    if DOCS_FOLDER is None:
        raise HTTPException(status_code=500, detail="Documentation folder not configured. Please set DOCS_FOLDER environment variable or run with --docs-folder argument.")
    
    # Security check: ensure we're only serving .md files and they exist in the docs folder
    if not filename.endswith('.md'):
        raise HTTPException(status_code=404, detail="Only markdown files are supported")
    
    file_path = Path(DOCS_FOLDER) / filename
    
    # Ensure the file is within the docs folder (prevent directory traversal)
    try:
        file_path = file_path.resolve()
        docs_folder_resolved = Path(DOCS_FOLDER).resolve()
        if not str(file_path).startswith(str(docs_folder_resolved)):
            raise HTTPException(status_code=403, detail="Access denied")
    except Exception:
        raise HTTPException(status_code=403, detail="Invalid file path")
    
    if not file_path.exists():
        raise HTTPException(status_code=404, detail=f"File {filename} not found")
    
    try:
        content = file_manager.load_text(file_path)
        
        html_content = markdown_to_html(content)
        title = get_file_title(file_path)
        
        context = {
            "title": title,
            "content": html_content,
            "navigation": MODULE_TREE,
            "current_page": filename
        }
        
        return HTMLResponse(content=render_template(DOCS_VIEW_TEMPLATE, context))
        
    except Exception as e:
        raise HTTPException(status_code=500, detail=f"Error reading {filename}: {e}")


# Mount static files