在Sphinx笔记中实现本地HTML、CSS、JS代码的在线预览,可以通过以下步骤来实现:
首先,创建一个HTML文件,用于嵌入你的CSS和JS代码。例如,创建一个名为 preview.html
的文件:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Preview</title>
<link rel="stylesheet" href="styles.css">
</head>
<body>
<h1>Hello, World!</h1>
<script src="script.js"></script>
</body>
</html>
在同一目录下创建 styles.css
和 script.js
文件:
styles.css
:body {
background-color: lightblue;
font-family: Arial, sans-serif;
}
script.js
:document.querySelector('h1').addEventListener('click', function() {
alert('Hello, World!');
});
在Sphinx的 .rst
文件中,你可以使用 raw
指令来嵌入HTML代码。例如:
.. raw:: html
:file: preview.html
确保Sphinx配置文件中允许嵌入HTML文件。在 conf.py
中添加或修改以下配置:
# 允许嵌入HTML文件
html_extra_path = ['preview.html', 'styles.css', 'script.js']
使用Sphinx构建你的文档:
make html
构建完成后,打开生成的HTML文件,你应该能够看到嵌入的HTML、CSS和JS代码的效果。
如果你希望在一个单独的iframe中预览HTML文件,可以在Sphinx的 .rst
文件中使用以下代码:
.. raw:: html
<iframe src="preview.html" width="100%" height="500px"></iframe>
为了确保所有资源(如CSS和JS文件)都能正确加载,你可以在本地启动一个简单的HTTP服务器。例如,使用Python的内置HTTP服务器:
python -m http.server 8000
然后在浏览器中访问 http://localhost:8000
来查看预览效果。
通过以上步骤,你可以在Sphinx笔记中实现本地HTML、CSS、JS代码的在线预览。确保所有文件路径正确,并且在Sphinx配置中允许嵌入HTML文件。